Skip to content
Permalink
Browse files
Fix raises sphinx format
  • Loading branch information
nyalldawson committed Jun 25, 2021
1 parent 3274780 commit 711a615be301c5c7b57047173fa6b82fd27db0fa
Showing with 119 additions and 119 deletions.
  1. +2 −2 python/core/auto_generated/geometry/qgscurvepolygon.sip.in
  2. +20 −20 python/core/auto_generated/geometry/qgsgeometry.sip.in
  3. +4 −4 python/core/auto_generated/geometry/qgsgeometrycollection.sip.in
  4. +12 −12 python/core/auto_generated/geometry/qgslinestring.sip.in
  5. +1 −1 python/core/auto_generated/geometry/qgsmulticurve.sip.in
  6. +1 −1 python/core/auto_generated/geometry/qgsmultilinestring.sip.in
  7. +1 −1 python/core/auto_generated/geometry/qgsmultipoint.sip.in
  8. +1 −1 python/core/auto_generated/geometry/qgsmultipolygon.sip.in
  9. +1 −1 python/core/auto_generated/geometry/qgsmultisurface.sip.in
  10. +2 −2 python/core/auto_generated/pointcloud/qgspointclouddataprovider.sip.in
  11. +1 −1 python/core/auto_generated/processing/qgsprocessingalgorithm.sip.in
  12. +1 −1 python/core/auto_generated/processing/qgsprocessingparameters.sip.in
  13. +2 −2 python/core/auto_generated/proj/qgscoordinatereferencesystem.sip.in
  14. +1 −1 python/core/auto_generated/proj/qgscoordinatereferencesystemregistry.sip.in
  15. +1 −1 python/core/auto_generated/proj/qgsellipsoidutils.sip.in
  16. +24 −24 python/core/auto_generated/providers/qgsabstractdatabaseproviderconnection.sip.in
  17. +8 −8 python/core/auto_generated/providers/qgsprovidermetadata.sip.in
  18. +1 −1 python/core/auto_generated/providers/qgsproviderregistry.sip.in
  19. +1 −1 python/core/auto_generated/qgsconnectionregistry.sip.in
  20. +6 −6 python/core/auto_generated/qgsfeature.sip.in
  21. +1 −1 python/core/auto_generated/qgsfield.sip.in
  22. +7 −7 python/core/auto_generated/qgsfields.sip.in
  23. +1 −1 python/core/auto_generated/qgsfileutils.sip.in
  24. +1 −1 python/core/auto_generated/qgspathresolver.sip.in
  25. +1 −1 python/core/auto_generated/qgsspatialindex.sip.in
  26. +1 −1 python/core/auto_generated/qgsvector.sip.in
  27. +3 −3 python/core/auto_generated/symbology/qgssymbol.sip.in
  28. +1 −1 python/core/auto_generated/textrenderer/qgstextblock.sip.in
  29. +1 −1 python/core/auto_generated/textrenderer/qgstextdocument.sip.in
  30. +1 −1 python/gui/auto_generated/qgsmapcanvas.sip.in
  31. +2 −2 python/server/auto_generated/qgsserverapiutils.sip.in
  32. +4 −4 python/server/auto_generated/qgsserverogcapihandler.sip.in
  33. +2 −2 python/server/auto_generated/qgsserverparameters.sip.in
  34. +1 −1 python/server/auto_generated/qgsserverquerystringparameter.sip.in
  35. +1 −1 scripts/sipify.pl
@@ -96,7 +96,7 @@ Returns the curve polygon's exterior ring.
%Docstring
Retrieves an interior ring from the curve polygon. The first interior ring has index 0.

:raises `IndexError` if no interior ring with the specified index exists.
:raises IndexError: if no interior ring with the specified index exists.

.. seealso:: :py:func:`numInteriorRings`

@@ -152,7 +152,7 @@ Removes an interior ring from the polygon. The first interior ring has index 0.
The corresponding ring is removed from the polygon and deleted.
It is not possible to remove the exterior ring using this method.

:raises `IndexError` if no interior ring with the specified index exists.
:raises IndexError: if no interior ring with the specified index exists.

.. seealso:: :py:func:`removeInteriorRings`
%End
@@ -577,7 +577,7 @@ In case of error -1 will be returned.

This method requires a QGIS build based on GEOS 3.7 or later.

:raises `QgsNotSupportedException` on QGIS builds based on GEOS 3.6 or earlier.
:raises QgsNotSupportedException: on QGIS builds based on GEOS 3.6 or earlier.

.. seealso:: :py:func:`frechetDistanceDensify`

@@ -603,7 +603,7 @@ distance returned approach the true Fréchet distance for the geometries.

This method requires a QGIS build based on GEOS 3.7 or later.

:raises `QgsNotSupportedException` on QGIS builds based on GEOS 3.6 or earlier.
:raises QgsNotSupportedException: on QGIS builds based on GEOS 3.6 or earlier.

.. seealso:: :py:func:`frechetDistance`

@@ -1474,7 +1474,7 @@ This method requires QGIS builds based on GEOS 3.9 or later.

the ``tolerance`` value must be a value greater than 0, or the algorithm may never converge on a solution

:raises `QgsNotSupportedException` on QGIS builds based on GEOS 3.8 or earlier.
:raises QgsNotSupportedException: on QGIS builds based on GEOS 3.8 or earlier.


.. versionadded:: 3.20
@@ -1491,7 +1491,7 @@ can be moved through, with a single rotation.

This method requires a QGIS build based on GEOS 3.6 or later.

:raises `QgsNotSupportedException` on QGIS builds based on GEOS 3.5 or earlier.
:raises QgsNotSupportedException: on QGIS builds based on GEOS 3.5 or earlier.

.. versionadded:: 3.20
%End
@@ -1514,7 +1514,7 @@ If an error occurs while calculating the clearance NaN will be returned.

This method requires a QGIS build based on GEOS 3.6 or later.

:raises `QgsNotSupportedException` on QGIS builds based on GEOS 3.5 or earlier.
:raises QgsNotSupportedException: on QGIS builds based on GEOS 3.5 or earlier.

.. versionadded:: 3.20
%End
@@ -1527,7 +1527,7 @@ If the geometry has no minimum clearance, an empty LineString will be returned.

This method requires a QGIS build based on GEOS 3.6 or later.

:raises `QgsNotSupportedException` on QGIS builds based on GEOS 3.5 or earlier.
:raises QgsNotSupportedException: on QGIS builds based on GEOS 3.5 or earlier.

.. versionadded:: 3.20
%End
@@ -1755,9 +1755,9 @@ is 0, then a completely random sequence of points will be generated.

This method works only with (multi)polygon geometry types.

:raises `TypeError` if the geometry is not a polygon type
:raises TypeError: if the geometry is not a polygon type

:raises `ValueError` if the geometry is null
:raises ValueError: if the geometry is null

.. versionadded:: 3.10
%End
@@ -1886,9 +1886,9 @@ Any z or m values present in the geometry will be discarded.

This method works only with single-point geometry types.

:raises `TypeError` if the geometry is not a single-point type
:raises TypeError: if the geometry is not a single-point type

:raises `ValueError` if the geometry is null
:raises ValueError: if the geometry is null
%End
%MethodCode
const QgsWkbTypes::Type type = sipCpp->wkbType();
@@ -1918,9 +1918,9 @@ Any z or m values present in the geometry will be discarded. If the geometry is

This method works only with single-line (or single-curve).

:raises `TypeError` if the geometry is not a single-line type
:raises TypeError: if the geometry is not a single-line type

:raises `ValueError` if the geometry is null
:raises ValueError: if the geometry is null
%End
%MethodCode
const QgsWkbTypes::Type type = sipCpp->wkbType();
@@ -1951,9 +1951,9 @@ Any z or m values present in the geometry will be discarded. If the geometry is

This method works only with single-polygon (or single-curve polygon) geometry types.

:raises `TypeError` if the geometry is not a single-polygon type
:raises TypeError: if the geometry is not a single-polygon type

:raises `ValueError` if the geometry is null
:raises ValueError: if the geometry is null
%End
%MethodCode
const QgsWkbTypes::Type type = sipCpp->wkbType();
@@ -1983,9 +1983,9 @@ Any z or m values present in the geometry will be discarded.

This method works only with multi-point geometry types.

:raises `TypeError` if the geometry is not a multi-point type
:raises TypeError: if the geometry is not a multi-point type

:raises `ValueError` if the geometry is null
:raises ValueError: if the geometry is null
%End
%MethodCode
const QgsWkbTypes::Type type = sipCpp->wkbType();
@@ -2016,9 +2016,9 @@ Any z or m values present in the geometry will be discarded. If the geometry is

This method works only with multi-linestring (or multi-curve) geometry types.

:raises `TypeError` if the geometry is not a multi-linestring type
:raises TypeError: if the geometry is not a multi-linestring type

:raises `ValueError` if the geometry is null
:raises ValueError: if the geometry is null
%End
%MethodCode
const QgsWkbTypes::Type type = sipCpp->wkbType();
@@ -2049,9 +2049,9 @@ Any z or m values present in the geometry will be discarded. If the geometry is

This method works only with multi-polygon (or multi-curve polygon) geometry types.

:raises `TypeError` if the geometry is not a multi-polygon type
:raises TypeError: if the geometry is not a multi-polygon type

:raises `ValueError` if the geometry is null
:raises ValueError: if the geometry is null
%End
%MethodCode
const QgsWkbTypes::Type type = sipCpp->wkbType();
@@ -71,7 +71,7 @@ Returns a geometry from within the collection.

:param n: index of geometry to return.

:raises `IndexError` if no geometry with the specified index exists.
:raises IndexError: if no geometry with the specified index exists.
%End
%MethodCode
if ( a0 < 0 || a0 >= sipCpp->numGeometries() )
@@ -137,7 +137,7 @@ Removes a geometry from the collection by index.

:return: ``True`` if removal was successful.

:raises `IndexError` if no geometry with the specified index exists.
:raises IndexError: if no geometry with the specified index exists.
%End
%MethodCode
const int count = sipCpp->numGeometries();
@@ -263,7 +263,7 @@ Returns the geometry at the specified ``index``.
Indexes can be less than 0, in which case they correspond to geometries from the end of the collect. E.g. an index of -1
corresponds to the last geometry in the collection.

:raises `IndexError` if no geometry with the specified ``index`` exists.
:raises IndexError: if no geometry with the specified ``index`` exists.

.. versionadded:: 3.6
%End
@@ -291,7 +291,7 @@ Deletes the geometry at the specified ``index``.
Indexes can be less than 0, in which case they correspond to geometries from the end of the collection. E.g. an index of -1
corresponds to the last geometry in the collection.

:raises `IndexError` if no geometry at the ``index`` exists
:raises IndexError: if no geometry at the ``index`` exists

.. versionadded:: 3.6
%End
@@ -279,7 +279,7 @@ Returns the point at the specified index.
Indexes can be less than 0, in which case they correspond to positions from the end of the line. E.g. an index of -1
corresponds to the last point in the line.

:raises `IndexError` if no point with the specified index exists.
:raises IndexError: if no point with the specified index exists.
%End
%MethodCode
const int count = sipCpp->numPoints();
@@ -308,7 +308,7 @@ Returns the x-coordinate of the specified node in the line string.
Indexes can be less than 0, in which case they correspond to positions from the end of the line. E.g. an index of -1
corresponds to the last point in the line.

:raises `IndexError` if no point with the specified index exists.
:raises IndexError: if no point with the specified index exists.
%End
%MethodCode
const int count = sipCpp->numPoints();
@@ -335,7 +335,7 @@ Returns the y-coordinate of the specified node in the line string.
Indexes can be less than 0, in which case they correspond to positions from the end of the line. E.g. an index of -1
corresponds to the last point in the line.

:raises `IndexError` if no point with the specified index exists.
:raises IndexError: if no point with the specified index exists.
%End
%MethodCode
const int count = sipCpp->numPoints();
@@ -367,7 +367,7 @@ If the LineString does not have a z-dimension then ``nan`` will be returned.
Indexes can be less than 0, in which case they correspond to positions from the end of the line. E.g. an index of -1
corresponds to the last point in the line.

:raises `IndexError` if no point with the specified index exists.
:raises IndexError: if no point with the specified index exists.
%End
%MethodCode
const int count = sipCpp->numPoints();
@@ -395,7 +395,7 @@ If the LineString does not have a m-dimension then ``nan`` will be returned.
Indexes can be less than 0, in which case they correspond to positions from the end of the line. E.g. an index of -1
corresponds to the last point in the line.

:raises `IndexError` if no point with the specified index exists.
:raises IndexError: if no point with the specified index exists.
%End
%MethodCode
const int count = sipCpp->numPoints();
@@ -422,7 +422,7 @@ The corresponding node must already exist in line string.
Indexes can be less than 0, in which case they correspond to positions from the end of the line. E.g. an index of -1
corresponds to the last point in the line.

:raises `IndexError` if no point with the specified index exists.
:raises IndexError: if no point with the specified index exists.

.. seealso:: :py:func:`xAt`
%End
@@ -451,7 +451,7 @@ The corresponding node must already exist in line string.
Indexes can be less than 0, in which case they correspond to positions from the end of the line. E.g. an index of -1
corresponds to the last point in the line.

:raises `IndexError` if no point with the specified index exists.
:raises IndexError: if no point with the specified index exists.

.. seealso:: :py:func:`yAt`
%End
@@ -480,7 +480,7 @@ The corresponding node must already exist in line string and the line string mus
Indexes can be less than 0, in which case they correspond to positions from the end of the line. E.g. an index of -1
corresponds to the last point in the line.

:raises `IndexError` if no point with the specified index exists.
:raises IndexError: if no point with the specified index exists.

.. seealso:: :py:func:`zAt`
%End
@@ -509,7 +509,7 @@ The corresponding node must already exist in line string and the line string mus
Indexes can be less than 0, in which case they correspond to positions from the end of the line. E.g. an index of -1
corresponds to the last point in the line.

:raises `IndexError` if no point with the specified index exists.
:raises IndexError: if no point with the specified index exists.

.. seealso:: :py:func:`mAt`
%End
@@ -743,7 +743,7 @@ Returns the point at the specified ``index``.
Indexes can be less than 0, in which case they correspond to positions from the end of the line. E.g. an index of -1
corresponds to the last point in the line.

:raises `IndexError` if no point with the specified ``index`` exists.
:raises IndexError: if no point with the specified ``index`` exists.

.. versionadded:: 3.6
%End
@@ -772,7 +772,7 @@ Sets the point at the specified ``index``.
Indexes can be less than 0, in which case they correspond to positions from the end of the line. E.g. an index of -1
corresponds to the last point in the line.

:raises `IndexError` if no point with the specified ``index`` exists.
:raises IndexError: if no point with the specified ``index`` exists.

.. versionadded:: 3.6
%End
@@ -804,7 +804,7 @@ Deletes the vertex at the specified ``index``.
Indexes can be less than 0, in which case they correspond to positions from the end of the line. E.g. an index of -1
corresponds to the last point in the line.

:raises `IndexError` if no point with the specified ``index`` exists.
:raises IndexError: if no point with the specified ``index`` exists.

.. versionadded:: 3.6
%End
@@ -28,7 +28,7 @@ Multi curve geometry collection.
%Docstring
Returns the curve with the specified ``index``.

:raises `IndexError` if no curve with the specified index exists.
:raises IndexError: if no curve with the specified index exists.

.. versionadded:: 3.16
%End
@@ -33,7 +33,7 @@ Constructor for an empty multilinestring geometry.
%Docstring
Returns the line string with the specified ``index``.

:raises `IndexError` if no line string with the specified index exists.
:raises IndexError: if no line string with the specified index exists.

.. versionadded:: 3.16
%End
@@ -31,7 +31,7 @@ Constructor for an empty multipoint geometry.
%Docstring
Returns the point with the specified ``index``.

:raises `IndexError` if no point with the specified index exists.
:raises IndexError: if no point with the specified index exists.

.. versionadded:: 3.16
%End
@@ -33,7 +33,7 @@ Constructor for an empty multipolygon geometry.
%Docstring
Returns the polygon with the specified ``index``.

:raises `IndexError` if no polygon with the specified index exists.
:raises IndexError: if no polygon with the specified index exists.

.. versionadded:: 3.16
%End
@@ -33,7 +33,7 @@ Constructor for an empty multisurface geometry.
%Docstring
Returns the surface with the specified ``index``.

:raises `IndexError` if no surface with the specified index exists.
:raises IndexError: if no surface with the specified index exists.

.. versionadded:: 3.16
%End
@@ -178,7 +178,7 @@ This method will not perform any statistical calculations, rather it will return
statistics which are included in the data source's metadata. Not all data sources include this information
in the metadata, and even for sources with statistical metadata only some ``statistic`` values may be available.

:raises `ValueError` if no matching precalculated statistic is available for the attribute.
:raises ValueError: if no matching precalculated statistic is available for the attribute.
%End
%MethodCode
{
@@ -216,7 +216,7 @@ This method will not perform any statistical calculations, rather it will return
statistics which are included in the data source's metadata. Not all data sources include this information
in the metadata, and even for sources with statistical metadata only some ``statistic`` values may be available.

:raises `ValueError` if no matching precalculated statistic is available for the attribute.
:raises ValueError: if no matching precalculated statistic is available for the attribute.
%End
%MethodCode
{
@@ -701,7 +701,7 @@ The ``datasourceOptions`` and ``layerOptions`` arguments is used to pass on GDAL

This function creates a new object and the caller takes responsibility for deleting the returned object.

:raises `QgsProcessingException`
:raises QgsProcessingException:
%End

QgsProcessingFeatureSource *parameterAsSource( const QVariantMap &parameters, const QString &name, QgsProcessingContext &context ) const /Factory/;
@@ -1007,7 +1007,7 @@ The ``datasourceOptions`` and ``layerOptions`` arguments is used to pass on GDAL

This function creates a new object and the caller takes responsibility for deleting the returned object.

:raises `QgsProcessingException`
:raises QgsProcessingException:

.. versionadded:: 3.4
%End
@@ -818,7 +818,7 @@ be returned.

This method requires PROJ 8.0 or later

:raises `QgsNotSupportedException` on QGIS builds based on PROJ 7 or earlier.
:raises QgsNotSupportedException: on QGIS builds based on PROJ 7 or earlier.


.. versionadded:: 3.20
@@ -832,7 +832,7 @@ Attempts to retrieve the name of the celestial body associated with the CRS (e.g

This method requires PROJ 8.1 or later

:raises `QgsNotSupportedException` on QGIS builds based on PROJ 8.0 or earlier.
:raises QgsNotSupportedException: on QGIS builds based on PROJ 8.0 or earlier.


.. versionadded:: 3.20

0 comments on commit 711a615

Please sign in to comment.