Skip to content

Commit

Permalink
Browse files Browse the repository at this point in the history
Followup 30700f1, ensure links to Qgis members are set in docstrings
  • Loading branch information
nyalldawson committed Mar 31, 2023
1 parent 73fea28 commit 50c7692
Show file tree
Hide file tree
Showing 39 changed files with 119 additions and 119 deletions.
Binary file added githubprivate.key
Binary file not shown.
2 changes: 1 addition & 1 deletion python/core/auto_generated/browser/qgsdirectoryitem.sip.in
Expand Up @@ -123,7 +123,7 @@ Check if the given path is hidden from the browser model
Returns the monitoring setting for a directory ``path``.

This method returns the monitoring setting for ``path`` only. If no explicit monitoring setting
is in place for the path then Qgis.BrowserDirectoryMonitoring.Default is returned.
is in place for the path then :py:class:`Qgis`.BrowserDirectoryMonitoring.Default is returned.

This method does not consider the monitoring setting of parent directories.

Expand Down
Expand Up @@ -45,7 +45,7 @@ Returns a :py:class:`QgsExternalStorageStoredContent` to follow the status of th

``storingMode`` defines if the download will start immediately or shall be manually triggered
calling :py:func:`QgsExternalStorageStoredContent.store()`. User should use
Qgis.ActionStart.Deferred if he needs to connect the :py:func:`~QgsExternalStorage.stored` signal.
:py:class:`Qgis`.ActionStart.Deferred if he needs to connect the :py:func:`~QgsExternalStorage.stored` signal.

After using this method, user wait for :py:func:`QgsExternalStorageStoredContent.stored()`,
:py:func:`QgsExternalStorageStoredContent.errorOccurred()` or :py:func:`QgsExternalStorageStoredContent.canceled()` signals.
Expand All @@ -63,7 +63,7 @@ Returns a :py:class:`QgsExternalStorageFetchedContent` to follow the status of t

``fetchingMode`` defines if the download will start immediately or shall be manually triggered
calling :py:func:`QgsExternalStorageFetchedContent.fetch()`. User should use
Qgis.ActionStart.Deferred if he needs to connect the :py:func:`~QgsExternalStorage.fetched` signal.
:py:class:`Qgis`.ActionStart.Deferred if he needs to connect the :py:func:`~QgsExternalStorage.fetched` signal.

After using this method, user should wait for :py:func:`QgsExternalStorageStoredContent.fetched()`,
:py:func:`QgsExternalStorageStoredContent.errorOccurred()` or :py:func:`QgsExternalStorageStoredContent.canceled()` signals.
Expand Down
Expand Up @@ -749,7 +749,7 @@ This method returns a reference only, and does not involve any geometry cloning.
Checks validity of the geometry, and returns ``True`` if the geometry is valid.

:param flags: indicates optional flags which control the type of validity checking performed
(corresponding to Qgis.GeometryValidityFlags).
(corresponding to :py:class:`Qgis`.GeometryValidityFlags).

:return: - ``True`` if geometry is valid
- error: will be set to the validity error message
Expand Down
2 changes: 1 addition & 1 deletion python/core/auto_generated/geometry/qgsgeometry.sip.in
Expand Up @@ -307,7 +307,7 @@ Returns type of the geometry as a WKB type (point / linestring / polygon etc.)

Qgis::GeometryType type() const /HoldGIL/;
%Docstring
Returns type of the geometry as a Qgis.GeometryType
Returns type of the geometry as a :py:class:`Qgis`.GeometryType

.. seealso:: :py:func:`wkbType`
%End
Expand Down
2 changes: 1 addition & 1 deletion python/core/auto_generated/geometry/qgswkbtypes.sip.in
Expand Up @@ -191,7 +191,7 @@ Invalid geometry types will return a dimension of 0.
%Docstring
Returns the geometry type for a WKB type, e.g., both MultiPolygon and CurvePolygon would have a
PolygonGeometry geometry type.
GeometryCollections are reported as Qgis.GeometryType.Unknown.
GeometryCollections are reported as :py:class:`Qgis`.GeometryType.Unknown.
%End

static QString displayString( Qgis::WkbType type ) /HoldGIL/;
Expand Down
36 changes: 18 additions & 18 deletions python/core/auto_generated/gps/qgsvectorlayergpslogger.sip.in
Expand Up @@ -102,27 +102,27 @@ Depending on the ``component``, the field will either refer to the :py:func:`~Qg

Fields stored in the :py:func:`~QgsVectorLayerGpsLogger.pointsLayer` are:

- Qgis.GpsInformationComponent.Location:
- Qgis.GpsInformationComponent.Altitude:
- Qgis.GpsInformationComponent.GroundSpeed:
- Qgis.GpsInformationComponent.Bearing:
- Qgis.GpsInformationComponent.Pdop:
- Qgis.GpsInformationComponent.Hdop:
- Qgis.GpsInformationComponent.Vdop:
- Qgis.GpsInformationComponent.HorizontalAccuracy:
- Qgis.GpsInformationComponent.VerticalAccuracy:
- Qgis.GpsInformationComponent.HvAccuracy:
- Qgis.GpsInformationComponent.SatellitesUsed:
- Qgis.GpsInformationComponent.Timestamp:
- Qgis.GpsInformationComponent.TrackDistanceSinceLastPoint:
- Qgis.GpsInformationComponent.TrackTimeSinceLastPoint:
- :py:class:`Qgis`.GpsInformationComponent.Location:
- :py:class:`Qgis`.GpsInformationComponent.Altitude:
- :py:class:`Qgis`.GpsInformationComponent.GroundSpeed:
- :py:class:`Qgis`.GpsInformationComponent.Bearing:
- :py:class:`Qgis`.GpsInformationComponent.Pdop:
- :py:class:`Qgis`.GpsInformationComponent.Hdop:
- :py:class:`Qgis`.GpsInformationComponent.Vdop:
- :py:class:`Qgis`.GpsInformationComponent.HorizontalAccuracy:
- :py:class:`Qgis`.GpsInformationComponent.VerticalAccuracy:
- :py:class:`Qgis`.GpsInformationComponent.HvAccuracy:
- :py:class:`Qgis`.GpsInformationComponent.SatellitesUsed:
- :py:class:`Qgis`.GpsInformationComponent.Timestamp:
- :py:class:`Qgis`.GpsInformationComponent.TrackDistanceSinceLastPoint:
- :py:class:`Qgis`.GpsInformationComponent.TrackTimeSinceLastPoint:

Fields stored in the :py:func:`~QgsVectorLayerGpsLogger.tracksLayer` are:

- Qgis.GpsInformationComponent.TrackStartTime:
- Qgis.GpsInformationComponent.TrackEndTime:
- Qgis.GpsInformationComponent.TotalTrackLength:
- Qgis.GpsInformationComponent.TrackDistanceFromStart:
- :py:class:`Qgis`.GpsInformationComponent.TrackStartTime:
- :py:class:`Qgis`.GpsInformationComponent.TrackEndTime:
- :py:class:`Qgis`.GpsInformationComponent.TotalTrackLength:
- :py:class:`Qgis`.GpsInformationComponent.TrackDistanceFromStart:

.. seealso:: :py:func:`destinationField`
%End
Expand Down
Expand Up @@ -1848,7 +1848,7 @@ A geometry parameter for processing algorithms.
%Docstring
Constructor for QgsProcessingParameterGeometry.

The ``geometryTypes`` argument allows for specifying a list of geometry types (see Qgis.GeometryType) acceptable for this
The ``geometryTypes`` argument allows for specifying a list of geometry types (see :py:class:`Qgis`.GeometryType) acceptable for this
parameter. Passing a empty list will allow for any type of geometry.
The ``allowMultiPart`` argument allows specifying a multi part geometry
%End
Expand All @@ -1875,14 +1875,14 @@ Returns the type name for the parameter class.

QList<int> geometryTypes() const;
%Docstring
Returns the parameter allowed geometries, as a list of Qgis.GeometryType values.
Returns the parameter allowed geometries, as a list of :py:class:`Qgis`.GeometryType values.

.. seealso:: :py:func:`setGeometryTypes`
%End

void setGeometryTypes( const QList<int> &geometryTypes );
%Docstring
Sets the allowed ``geometryTypes``, as a list of Qgis.GeometryType values.
Sets the allowed ``geometryTypes``, as a list of :py:class:`Qgis`.GeometryType values.

.. seealso:: :py:func:`geometryTypes`
%End
Expand Down
Expand Up @@ -29,7 +29,7 @@ Returns the default coordinate order to use for the specified ``crs``.
.. warning::

This is quite a "coarse" method, in that many possible CRS axis don't map well to a simply X/Y or Y/X order.
Accordingly this method will default to returning Qgis.CoordinateOrder.XY unless we are reasonably certain of a Y/X order.
Accordingly this method will default to returning :py:class:`Qgis`.CoordinateOrder.XY unless we are reasonably certain of a Y/X order.
%End

static QString axisDirectionToAbbreviatedString( Qgis::CrsAxisDirection axis );
Expand Down
10 changes: 5 additions & 5 deletions python/core/auto_generated/project/qgsproject.sip.in
Expand Up @@ -976,15 +976,15 @@ Returns the edit buffer group
Should default values be evaluated on provider side when requested and not when committed.

.. deprecated::
Test whether the :py:func:`~QgsProject.flags` method returns the Qgis.ProjectFlag.EvaluateDefaultValuesOnProviderSide flag instead.
Test whether the :py:func:`~QgsProject.flags` method returns the :py:class:`Qgis`.ProjectFlag.EvaluateDefaultValuesOnProviderSide flag instead.
%End

void setEvaluateDefaultValues( bool evaluateDefaultValues ) /Deprecated/;
%Docstring
Defines if default values should be evaluated on provider side when requested and not when committed.

.. deprecated::
use setFlag( Qgis.ProjectFlag.EvaluateDefaultValuesOnProviderSide ) instead.
use setFlag( :py:class:`Qgis`.ProjectFlag.EvaluateDefaultValuesOnProviderSide ) instead.
%End

virtual QgsExpressionContext createExpressionContext() const;
Expand Down Expand Up @@ -1348,7 +1348,7 @@ materialized views with Postgres provider.
:param trust: ``True`` to trust the project, ``False`` otherwise

.. deprecated::
Use setFlag( Qgis.ProjectFlag.TrustStoredLayerStatistics ) instead.
Use setFlag( :py:class:`Qgis`.ProjectFlag.TrustStoredLayerStatistics ) instead.
%End

bool trustLayerMetadata() const /Deprecated/;
Expand All @@ -1361,7 +1361,7 @@ unicity is not checked for views and materialized views with Postgres
provider.

.. deprecated::
Test whether the :py:func:`~QgsProject.flags` method returns the Qgis.ProjectFlag.TrustStoredLayerStatistics flag instead.
Test whether the :py:func:`~QgsProject.flags` method returns the :py:class:`Qgis`.ProjectFlag.TrustStoredLayerStatistics flag instead.
%End


Expand Down Expand Up @@ -1728,7 +1728,7 @@ Emitted when a layer is loaded
Emitted when loading layers has produced some messages

:param layerName: the layer name
:param messages: a list of pairs of Qgis.MessageLevel and messages
:param messages: a list of pairs of :py:class:`Qgis`.MessageLevel and messages

.. versionadded:: 3.2
%End
Expand Down
Expand Up @@ -120,7 +120,7 @@ Sets the default coordinate axis ``order`` to use when displaying coordinates fo

QgsCoordinateReferenceSystem coordinateCustomCrs() const;
%Docstring
Returns the coordinate custom CRS used when the project coordinate type is set to Qgis.CoordinateDisplayType.CustomCrs.
Returns the coordinate custom CRS used when the project coordinate type is set to :py:class:`Qgis`.CoordinateDisplayType.CustomCrs.

.. seealso:: :py:func:`setCoordinateCustomCrs`

Expand All @@ -129,7 +129,7 @@ Returns the coordinate custom CRS used when the project coordinate type is set t

void setCoordinateCustomCrs( const QgsCoordinateReferenceSystem &crs );
%Docstring
Sets the coordinate custom CRS used when the project coordinate type is set to Qgis.CoordinateDisplayType.CustomCrs.
Sets the coordinate custom CRS used when the project coordinate type is set to :py:class:`Qgis`.CoordinateDisplayType.CustomCrs.

.. seealso:: :py:func:`setCoordinateCustomCrs`

Expand Down
Expand Up @@ -149,7 +149,7 @@ Retrieves JSON definitions for all items which belong the the specified ``groupI
:param contentUrl: should be set to the Portal's content URL, e.g. https://mysite.com/portal/sharing/rest/content
:param groupId: ID of group to query
:param authcfg: authentication configuration ID
:param itemTypes: list of desired item types (using Qgis.ArcGisRestServiceType values)
:param itemTypes: list of desired item types (using :py:class:`Qgis`.ArcGisRestServiceType values)
:param requestHeaders: optional additional request headers
:param feedback: optional feedback argument for cancellation support
:param pageSize: number of results to retrieve for each request. Maximum value is 100.
Expand All @@ -170,7 +170,7 @@ Retrieves JSON definitions for all items which belong the the specified ``groupI
:param contentUrl: should be set to the Portal's content URL, e.g. https://mysite.com/portal/sharing/rest/content
:param groupId: ID of group to query
:param authcfg: authentication configuration ID
:param itemTypes: list of desired item types (using Qgis.ArcGisRestServiceType values)
:param itemTypes: list of desired item types (using :py:class:`Qgis`.ArcGisRestServiceType values)
:param requestHeaders: optional additional request headers
:param feedback: optional feedback argument for cancellation support
:param pageSize: number of results to retrieve for each request. Maximum value is 100.
Expand Down
Expand Up @@ -93,7 +93,7 @@ Returns the number of fetched rows.

long long rowCount( ) const;
%Docstring
Returns the number of rows returned by a SELECT query or Qgis.FeatureCountState.UnknownCount if unknown.
Returns the number of rows returned by a SELECT query or :py:class:`Qgis`.FeatureCountState.UnknownCount if unknown.

.. seealso:: :py:func:`fetchedRowCount`
%End
Expand Down
Expand Up @@ -179,7 +179,7 @@ the hierarchy of a dataset which organises layers in schemas or in an internal f
%Docstring
Returns the layer's feature count.

Will return Qgis.FeatureCountState.UnknownCount or Qgis.FeatureCountState.Uncounted if no feature count is applicable or available.
Will return :py:class:`Qgis`.FeatureCountState.UnknownCount or :py:class:`Qgis`.FeatureCountState.Uncounted if no feature count is applicable or available.

.. seealso:: :py:func:`setFeatureCount`
%End
Expand All @@ -188,7 +188,7 @@ Will return Qgis.FeatureCountState.UnknownCount or Qgis.FeatureCountState.Uncoun
%Docstring
Sets the layer's feature ``count``.

Set to Qgis.FeatureCountState.UnknownCount or Qgis.FeatureCountState.Uncounted if no feature count is applicable or available.
Set to :py:class:`Qgis`.FeatureCountState.UnknownCount or :py:class:`Qgis`.FeatureCountState.Uncounted if no feature count is applicable or available.

.. seealso:: :py:func:`featureCount`
%End
Expand Down
Expand Up @@ -36,7 +36,7 @@ Returns ``True`` if the sublayer ``details`` are incomplete, and require a more
scan.

For instance, if the details contain any vector sublayers with unknown geometry types
then a query with the Qgis.SublayerQueryFlag.ResolveGeometryType flag is required.
then a query with the :py:class:`Qgis`.SublayerQueryFlag.ResolveGeometryType flag is required.

The ``flags`` argument can be used to control the level of completeness required during the test.
%End
Expand Down
2 changes: 1 addition & 1 deletion python/core/auto_generated/qgis.sip.in
Expand Up @@ -23,7 +23,7 @@ int QgisEvent = QEvent::User + 1;
class Qgis
{
%Docstring(signature="appended")
The Qgis class provides global constants for use throughout the application.
The :py:class:`Qgis` class provides global constants for use throughout the application.
%End

%TypeHeaderCode
Expand Down
18 changes: 9 additions & 9 deletions python/core/auto_generated/qgsfeaturerequest.sip.in
Expand Up @@ -24,8 +24,8 @@ The request may apply an attribute/ID filter to fetch only a particular subset o
Additionally a spatial filter can be set in combination with the attribute/ID filter. Supported
spatial filters are:

- Qgis.SpatialFilterType.BoundingBox: Only features that intersect a given rectangle will be fetched. For the sake of speed, the intersection is often done only using feature's bounding box. There is a flag ExactIntersect that makes sure that only intersecting features will be returned.
- Qgis.SpatialFilterType.DistanceWithin: Only features within a specified distance of a reference geometry will be fetched.
- :py:class:`Qgis`.SpatialFilterType.BoundingBox: Only features that intersect a given rectangle will be fetched. For the sake of speed, the intersection is often done only using feature's bounding box. There is a flag ExactIntersect that makes sure that only intersecting features will be returned.
- :py:class:`Qgis`.SpatialFilterType.DistanceWithin: Only features within a specified distance of a reference geometry will be fetched.

For efficiency, it is also possible to tell provider that some data is not required:

Expand Down Expand Up @@ -351,8 +351,8 @@ When a destination CRS is set using :py:func:`~QgsFeatureRequest.setDestinationC
is expected to be in the same CRS as the :py:func:`~QgsFeatureRequest.destinationCrs`. Otherwise, ``rectangle``
should use the same CRS as the source layer/provider.

Calling this method will automatically set :py:func:`~QgsFeatureRequest.spatialFilterType` to Qgis.SpatialFilterType.BoundingBox.
If ``rectangle`` is a null rectangle then :py:func:`~QgsFeatureRequest.spatialFilterType` will be reset to Qgis.SpatialFilterType.NoFilter.
Calling this method will automatically set :py:func:`~QgsFeatureRequest.spatialFilterType` to :py:class:`Qgis`.SpatialFilterType.BoundingBox.
If ``rectangle`` is a null rectangle then :py:func:`~QgsFeatureRequest.spatialFilterType` will be reset to :py:class:`Qgis`.SpatialFilterType.NoFilter.

.. seealso:: :py:func:`filterRect`
%End
Expand All @@ -362,9 +362,9 @@ If ``rectangle`` is a null rectangle then :py:func:`~QgsFeatureRequest.spatialFi
Returns the rectangle from which features will be taken. If the returned
rectangle is null, then no filter rectangle is set.

If :py:func:`~QgsFeatureRequest.spatialFilterType` is Qgis.SpatialFilterType.BoundingBox then only
If :py:func:`~QgsFeatureRequest.spatialFilterType` is :py:class:`Qgis`.SpatialFilterType.BoundingBox then only
features from within this bounding box will be fetched. If :py:func:`~QgsFeatureRequest.spatialFilterType`
is Qgis.SpatialFilterType.DistanceWithin then the returned rectangle
is :py:class:`Qgis`.SpatialFilterType.DistanceWithin then the returned rectangle
represents the bounding box of the :py:func:`~QgsFeatureRequest.referenceGeometry` extended by :py:func:`~QgsFeatureRequest.distanceWithin`.

When a destination CRS is set using :py:func:`~QgsFeatureRequest.setDestinationCrs`, the rectangle
Expand All @@ -385,7 +385,7 @@ the spatial units of the :py:func:`~QgsFeatureRequest.destinationCrs`. Otherwise
should use the same CRS as the source layer/provider and ``distance``
should use the spatial units as this same CRS.

Calling this method will automatically set :py:func:`~QgsFeatureRequest.spatialFilterType` to Qgis.SpatialFilterType.DistanceWithin.
Calling this method will automatically set :py:func:`~QgsFeatureRequest.spatialFilterType` to :py:class:`Qgis`.SpatialFilterType.DistanceWithin.

.. seealso:: :py:func:`filterRect`

Expand All @@ -396,7 +396,7 @@ Calling this method will automatically set :py:func:`~QgsFeatureRequest.spatialF
%Docstring
Returns the reference geometry used for spatial filtering of features.

When :py:func:`~QgsFeatureRequest.spatialFilterType` is Qgis.SpatialFilterType.DistanceWithin then only
When :py:func:`~QgsFeatureRequest.spatialFilterType` is :py:class:`Qgis`.SpatialFilterType.DistanceWithin then only
features within :py:func:`~QgsFeatureRequest.distanceWithin` units of the reference geometry will be
fetched.

Expand All @@ -413,7 +413,7 @@ will use the same CRS as the source layer/provider.
double distanceWithin() const;
%Docstring
Returns the maximum distance from the :py:func:`~QgsFeatureRequest.referenceGeometry` of fetched
features, if :py:func:`~QgsFeatureRequest.spatialFilterType` is Qgis.SpatialFilterType.DistanceWithin.
features, if :py:func:`~QgsFeatureRequest.spatialFilterType` is :py:class:`Qgis`.SpatialFilterType.DistanceWithin.

When a destination CRS is set using :py:func:`~QgsFeatureRequest.setDestinationCrs`, the distance
will be in the spatial units of :py:func:`~QgsFeatureRequest.destinationCrs`. Otherwise, the distance
Expand Down
4 changes: 2 additions & 2 deletions python/core/auto_generated/qgsfield.sip.in
Expand Up @@ -179,7 +179,7 @@ Returns the field comment
%Docstring
Returns the map of field metadata.

Map keys should match values from the Qgis.FieldMetadataProperty enum.
Map keys should match values from the :py:class:`Qgis`.FieldMetadataProperty enum.

.. seealso:: :py:func:`setMetadata`

Expand All @@ -200,7 +200,7 @@ Returns a specific metadata ``property``.
%Docstring
Sets the map of field ``metadata``.

Map keys should match values from the Qgis.FieldMetadataProperty enum.
Map keys should match values from the :py:class:`Qgis`.FieldMetadataProperty enum.

.. seealso:: :py:func:`metadata`

Expand Down
2 changes: 1 addition & 1 deletion python/core/auto_generated/qgsmessagelog.sip.in
Expand Up @@ -57,7 +57,7 @@ value for the message.

void messageReceived( bool received );
%Docstring
Emitted whenever the log receives a message which is not a Qgis.MessageLevel.Info level message
Emitted whenever the log receives a message which is not a :py:class:`Qgis`.MessageLevel.Info level message
and which has the ``notifyUser`` flag as ``True``.

If :py:class:`QgsMessageLogNotifyBlocker` objects have been created then this signal may be
Expand Down
4 changes: 2 additions & 2 deletions python/core/auto_generated/qgsrendercontext.sip.in
Expand Up @@ -731,8 +731,8 @@ Converts a size from the specified units to painter units (pixels). The conversi
specified by the optional scale parameter.

Since QGIS 3.22 the optional ``property`` argument can be used to specify the associated property. This
is used in some contexts to refine the converted size. For example, a Qgis.RenderSubcomponentProperty.BlurSize
property will be limited to a suitably fast range when the render context has the Qgis.RenderContextFlag.RenderSymbolPreview set.
is used in some contexts to refine the converted size. For example, a :py:class:`Qgis`.RenderSubcomponentProperty.BlurSize
property will be limited to a suitably fast range when the render context has the :py:class:`Qgis`.RenderContextFlag.RenderSymbolPreview set.

.. seealso:: :py:func:`convertToMapUnits`

Expand Down

0 comments on commit 50c7692

Please sign in to comment.