sharpetronics/QGIS
1
0
Fork 0
mirror of https://github.com/qgis/QGIS.git synced 2025-10-16 00:05:45 -04:00
Code Issues Packages Projects Releases Wiki Activity

Fix malformed python docs

Browse Source
This commit is contained in:
Nyall Dawson 2025-07-21 14:39:06 +10:00
parent f831914584
commit b5164a1b18
3 changed files with 29 additions and 19 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

11
python/PyQt6/core/auto_generated/stac/qgsstacitem.sip.in
View File

@ -105,9 +105,11 @@ Sets the id of the STAC Collection this Item references to
QDateTime dateTime() const; QDateTime dateTime() const;
%Docstring %Docstring
Returns the single nominal date/time for the item, stored in the item's Returns the single nominal date/time for the item, stored in the item's
``properties``(). If a temporal interval is more appropriate for this :py:func:`~QgsStacItem.properties`.
item then a null QDateTime is returned and the interval may be retrieved
with :py:func:`~QgsStacItem.dateTimeRange` If a temporal interval is more appropriate for this item then a null
QDateTime is returned and the interval may be retrieved with
:py:func:`~QgsStacItem.dateTimeRange`.
.. seealso:: :py:func:`hasDateTimeRange` .. seealso:: :py:func:`hasDateTimeRange`
@ -126,7 +128,8 @@ Returns ``True`` if a temporal interval is available for this item,
QgsDateTimeRange dateTimeRange() const; QgsDateTimeRange dateTimeRange() const;
%Docstring %Docstring
Returns the temporal interval stored in the item's ``properties``() Returns the temporal interval stored in the item's
:py:func:`~QgsStacItem.properties`.
.. seealso:: :py:func:`hasDateTimeRange` .. seealso:: :py:func:`hasDateTimeRange`

11
python/core/auto_generated/stac/qgsstacitem.sip.in
View File

@ -105,9 +105,11 @@ Sets the id of the STAC Collection this Item references to
QDateTime dateTime() const; QDateTime dateTime() const;
%Docstring %Docstring
Returns the single nominal date/time for the item, stored in the item's Returns the single nominal date/time for the item, stored in the item's
``properties``(). If a temporal interval is more appropriate for this :py:func:`~QgsStacItem.properties`.
item then a null QDateTime is returned and the interval may be retrieved
with :py:func:`~QgsStacItem.dateTimeRange` If a temporal interval is more appropriate for this item then a null
QDateTime is returned and the interval may be retrieved with
:py:func:`~QgsStacItem.dateTimeRange`.
.. seealso:: :py:func:`hasDateTimeRange` .. seealso:: :py:func:`hasDateTimeRange`
@ -126,7 +128,8 @@ Returns ``True`` if a temporal interval is available for this item,
QgsDateTimeRange dateTimeRange() const; QgsDateTimeRange dateTimeRange() const;
%Docstring %Docstring
Returns the temporal interval stored in the item's ``properties``() Returns the temporal interval stored in the item's
:py:func:`~QgsStacItem.properties`.
.. seealso:: :py:func:`hasDateTimeRange` .. seealso:: :py:func:`hasDateTimeRange`

26
src/core/stac/qgsstacitem.h
View File

@ -89,25 +89,29 @@ class CORE_EXPORT QgsStacItem : public QgsStacObject
void setCollection( const QString &collection ); void setCollection( const QString &collection );
/** /**
* Returns the single nominal date/time for the item, stored in the item's \a properties(). * Returns the single nominal date/time for the item, stored in the item's properties().
* If a temporal interval is more appropriate for this item then a null QDateTime is returned *
* and the interval may be retrieved with dateTimeRange() * If a temporal interval is more appropriate for this item then a null QDateTime is returned
* \see hasDateTimeRange() * and the interval may be retrieved with dateTimeRange().
* \see dateTimeRange() *
* \see hasDateTimeRange()
* \see dateTimeRange()
*/ */
QDateTime dateTime() const; QDateTime dateTime() const;
/** /**
* Returns TRUE if a temporal interval is available for this item, FALSE if a single QDateTime is available. * Returns TRUE if a temporal interval is available for this item, FALSE if a single QDateTime is available.
* \see hasDateTimeRange() *
* \see dateTime() * \see hasDateTimeRange()
* \see dateTime()
*/ */
bool hasDateTimeRange() const; bool hasDateTimeRange() const;
/** /**
* Returns the temporal interval stored in the item's \a properties() * Returns the temporal interval stored in the item's properties().
* \see hasDateTimeRange() *
* \see dateTime() * \see hasDateTimeRange()
* \see dateTime()
*/ */
QgsDateTimeRange dateTimeRange() const; QgsDateTimeRange dateTimeRange() const;