From b39f760cbcf556c6156b6e13085e8d7d0b566ecf Mon Sep 17 00:00:00 2001 From: Nyall Dawson Date: Tue, 10 Sep 2024 11:11:25 +1000 Subject: [PATCH 1/2] Correctly handle multiline SIP_OUT param documentation --- .../qgsgcpgeometrytransformer.sip.in | 2 +- .../qgsclassificationmethod.sip.in | 2 +- .../expression/qgsexpression.sip.in | 6 +-- .../geometry/qgsabstractgeometry.sip.in | 6 +-- .../auto_generated/geometry/qgscurve.sip.in | 4 +- .../geometry/qgsgeometry.sip.in | 8 ++-- .../geometry/qgsgeometryengine.sip.in | 4 +- .../geometry/qgsgeometryutils.sip.in | 17 ++++---- .../geometry/qgsgeometryutils_base.sip.in | 13 ++++--- .../gps/qgsgpsinformation.sip.in | 2 +- .../qgsfractionnumericformat.sip.in | 6 +-- .../painting/qgspainting.sip.in | 2 +- .../models/qgsprocessingmodelalgorithm.sip.in | 4 +- .../processing/qgsprocessingalgorithm.sip.in | 4 +- .../processing/qgsprocessingoutputs.sip.in | 4 +- .../processing/qgsprocessingparameters.sip.in | 8 ++-- .../processing/qgsprocessingutils.sip.in | 4 +- .../proj/qgscoordinatereferencesystem.sip.in | 2 +- .../auto_generated/project/qgsproject.sip.in | 6 +-- .../arcgis/qgsarcgisrestutils.sip.in | 2 +- .../providers/qgsprovidermetadata.sip.in | 4 +- .../providers/qgsproviderregistry.sip.in | 2 +- .../sensorthings/qgssensorthingsutils.sip.in | 2 +- .../auto_generated/qgsbookmarkmanager.sip.in | 2 +- .../auto_generated/qgsdistancearea.sip.in | 2 +- .../core/auto_generated/qgsfileutils.sip.in | 2 +- .../core/auto_generated/qgsimagecache.sip.in | 2 +- .../auto_generated/qgslayerdefinition.sip.in | 4 +- .../core/auto_generated/qgsmaplayer.sip.in | 39 +++++++++---------- .../auto_generated/qgsmaplayerfactory.sip.in | 2 +- .../qgsmultirenderchecker.sip.in | 2 +- .../core/auto_generated/qgsproperty.sip.in | 16 ++++---- .../qgspropertycollection.sip.in | 12 +++--- .../qgspropertytransformer.sip.in | 12 +++--- .../auto_generated/qgstemporalutils.sip.in | 10 ++--- .../core/auto_generated/qgsunittypes.sip.in | 24 ++++++------ .../auto_generated/qgsvectorfilewriter.sip.in | 15 ++++--- .../raster/qgsrasterattributetable.sip.in | 2 +- .../raster/qgsrasterlayerutils.sip.in | 2 +- .../raster/qgsrastershader.sip.in | 12 +++--- .../raster/qgsrastershaderfunction.sip.in | 12 +++--- .../symbology/qgsrenderer.sip.in | 2 +- .../symbology/qgssymbollayerutils.sip.in | 12 +++--- .../textrenderer/qgsfontmanager.sip.in | 8 ++-- .../vector/qgsvectorlayer.sip.in | 4 +- .../qgsvectorlayereditbuffergroup.sip.in | 4 +- .../vector/qgsvectorlayereditutils.sip.in | 2 +- .../vector/qgsvectorlayerexporter.sip.in | 4 +- .../qgsmapboxglstyleconverter.sip.in | 4 +- .../history/qgshistoryproviderregistry.sip.in | 4 +- .../auto_generated/qgsattributeform.sip.in | 2 +- .../qgsexpressionlineedit.sip.in | 2 +- .../qgsnewvectorlayerdialog.sip.in | 4 +- .../qgsgcpgeometrytransformer.sip.in | 2 +- .../qgsclassificationmethod.sip.in | 2 +- .../expression/qgsexpression.sip.in | 6 +-- .../geometry/qgsabstractgeometry.sip.in | 6 +-- .../auto_generated/geometry/qgscurve.sip.in | 4 +- .../geometry/qgsgeometry.sip.in | 8 ++-- .../geometry/qgsgeometryengine.sip.in | 4 +- .../geometry/qgsgeometryutils.sip.in | 17 ++++---- .../geometry/qgsgeometryutils_base.sip.in | 13 ++++--- .../gps/qgsgpsinformation.sip.in | 2 +- .../qgsfractionnumericformat.sip.in | 6 +-- .../painting/qgspainting.sip.in | 2 +- .../models/qgsprocessingmodelalgorithm.sip.in | 4 +- .../processing/qgsprocessingalgorithm.sip.in | 4 +- .../processing/qgsprocessingoutputs.sip.in | 4 +- .../processing/qgsprocessingparameters.sip.in | 8 ++-- .../processing/qgsprocessingutils.sip.in | 4 +- .../proj/qgscoordinatereferencesystem.sip.in | 2 +- .../auto_generated/project/qgsproject.sip.in | 6 +-- .../arcgis/qgsarcgisrestutils.sip.in | 2 +- .../providers/qgsprovidermetadata.sip.in | 4 +- .../providers/qgsproviderregistry.sip.in | 2 +- .../sensorthings/qgssensorthingsutils.sip.in | 2 +- .../auto_generated/qgsbookmarkmanager.sip.in | 2 +- .../auto_generated/qgsdistancearea.sip.in | 2 +- .../core/auto_generated/qgsfileutils.sip.in | 2 +- .../core/auto_generated/qgsimagecache.sip.in | 2 +- .../auto_generated/qgslayerdefinition.sip.in | 4 +- python/core/auto_generated/qgsmaplayer.sip.in | 39 +++++++++---------- .../auto_generated/qgsmaplayerfactory.sip.in | 2 +- .../qgsmultirenderchecker.sip.in | 2 +- python/core/auto_generated/qgsproperty.sip.in | 16 ++++---- .../qgspropertycollection.sip.in | 12 +++--- .../qgspropertytransformer.sip.in | 12 +++--- .../auto_generated/qgstemporalutils.sip.in | 10 ++--- .../core/auto_generated/qgsunittypes.sip.in | 24 ++++++------ .../auto_generated/qgsvectorfilewriter.sip.in | 15 ++++--- .../raster/qgsrasterattributetable.sip.in | 2 +- .../raster/qgsrasterlayerutils.sip.in | 2 +- .../raster/qgsrastershader.sip.in | 12 +++--- .../raster/qgsrastershaderfunction.sip.in | 12 +++--- .../symbology/qgsrenderer.sip.in | 2 +- .../symbology/qgssymbollayerutils.sip.in | 12 +++--- .../textrenderer/qgsfontmanager.sip.in | 8 ++-- .../vector/qgsvectorlayer.sip.in | 4 +- .../qgsvectorlayereditbuffergroup.sip.in | 4 +- .../vector/qgsvectorlayereditutils.sip.in | 2 +- .../vector/qgsvectorlayerexporter.sip.in | 4 +- .../qgsmapboxglstyleconverter.sip.in | 7 +--- .../history/qgshistoryproviderregistry.sip.in | 4 +- .../auto_generated/qgsattributeform.sip.in | 2 +- .../qgsexpressionlineedit.sip.in | 2 +- .../qgsnewvectorlayerdialog.sip.in | 4 +- scripts/sipify.py | 12 ++++-- src/core/qgsmaplayer.h | 2 + 108 files changed, 352 insertions(+), 341 deletions(-) diff --git a/python/PyQt6/analysis/auto_generated/georeferencing/qgsgcpgeometrytransformer.sip.in b/python/PyQt6/analysis/auto_generated/georeferencing/qgsgcpgeometrytransformer.sip.in index d6acb7d3e551..532ab0bd6db3 100644 --- a/python/PyQt6/analysis/auto_generated/georeferencing/qgsgcpgeometrytransformer.sip.in +++ b/python/PyQt6/analysis/auto_generated/georeferencing/qgsgcpgeometrytransformer.sip.in @@ -52,7 +52,7 @@ Transforms the specified input ``geometry`` using the GCP based transform. If this is done, the geometry will be left in a semi-transformed state. :return: - transformed geometry - - ok: will be set to ``True`` if geometry was successfully transformed, or ``False`` if an error occurred + - ok: ``True`` if geometry was successfully transformed, or ``False`` if an error occurred %End QgsGcpTransformerInterface *gcpTransformer() const; diff --git a/python/PyQt6/core/auto_generated/classification/qgsclassificationmethod.sip.in b/python/PyQt6/core/auto_generated/classification/qgsclassificationmethod.sip.in index 8da3bad66ea2..86c92dc31848 100644 --- a/python/PyQt6/core/auto_generated/classification/qgsclassificationmethod.sip.in +++ b/python/PyQt6/core/auto_generated/classification/qgsclassificationmethod.sip.in @@ -262,7 +262,7 @@ This will calculate the classes for a given layer to define the classes. :param nclasses: The number of classes to be returned :return: - list of generated classes - - error: will be set to error string if an error occurred while generating the classes + - error: error string if an error occurred while generating the classes .. versionadded:: 3.38 %End diff --git a/python/PyQt6/core/auto_generated/expression/qgsexpression.sip.in b/python/PyQt6/core/auto_generated/expression/qgsexpression.sip.in index 1141236cfb16..db436870ec42 100644 --- a/python/PyQt6/core/auto_generated/expression/qgsexpression.sip.in +++ b/python/PyQt6/core/auto_generated/expression/qgsexpression.sip.in @@ -696,8 +696,8 @@ Returns ``True`` if the given ``expression`` is a simple "field=value" type expr :param expression: expression to test :return: - ``True`` if the expression is a field equality expression - - field: will be set to the field name if the expression is a field equality expression - - value: will be set to the value if the expression is a field equality expression + - field: the field name if the expression is a field equality expression + - value: the value if the expression is a field equality expression .. versionadded:: 3.18 %End @@ -714,7 +714,7 @@ Returns ``True`` if the given ``expressions`` could be converted to an IN type e :param expressions: expressions to test :return: - ``True`` if the expression was converted to a field IN type expression - - result: will be set to the calculated "field IN (...)" expression, wherever possible + - result: the calculated "field IN (...)" expression, wherever possible .. versionadded:: 3.18 %End diff --git a/python/PyQt6/core/auto_generated/geometry/qgsabstractgeometry.sip.in b/python/PyQt6/core/auto_generated/geometry/qgsabstractgeometry.sip.in index 419cf292a82d..95481312721f 100644 --- a/python/PyQt6/core/auto_generated/geometry/qgsabstractgeometry.sip.in +++ b/python/PyQt6/core/auto_generated/geometry/qgsabstractgeometry.sip.in @@ -437,11 +437,11 @@ Returns the point corresponding to a specified vertex id Searches for the closest segment of the geometry to a given point. :param pt: specifies the point to find closest segment to -:param segmentPt: storage for the closest point within the geometry -:param vertexAfter: storage for the ID of the vertex at the end of the closest segment :param epsilon: epsilon for segment snapping :return: - squared distance to closest segment or negative value on error + - segmentPt: the closest point within the geometry + - vertexAfter: the ID of the vertex at the end of the closest segment - leftOf: indicates whether the point lies on the left side of the geometry (-1 if point is to the left of the geometry, +1 if the point is to the right of the geometry, or 0 for cases where left/right could not be determined, e.g. point exactly on a line) ``False`` if point is to right of segment) %End @@ -784,7 +784,7 @@ Checks validity of the geometry, and returns ``True`` if the geometry is valid. (corresponding to :py:class:`Qgis`.GeometryValidityFlags). :return: - ``True`` if geometry is valid - - error: will be set to the validity error message + - error: the validity error message .. versionadded:: 3.8 %End diff --git a/python/PyQt6/core/auto_generated/geometry/qgscurve.sip.in b/python/PyQt6/core/auto_generated/geometry/qgscurve.sip.in index 4135c6cf287d..53e387443ed2 100644 --- a/python/PyQt6/core/auto_generated/geometry/qgscurve.sip.in +++ b/python/PyQt6/core/auto_generated/geometry/qgscurve.sip.in @@ -144,8 +144,8 @@ Returns the point and vertex id of a point within the curve. :param node: node number, where the first node is 0 :return: - ``True`` if node exists within the curve - - point: will be set to point at corresponding node in the curve - - type: will be set to the vertex type of the node + - point: point at corresponding node in the curve + - type: the vertex type of the node %End virtual int indexOf( const QgsPoint &point ) const = 0; diff --git a/python/PyQt6/core/auto_generated/geometry/qgsgeometry.sip.in b/python/PyQt6/core/auto_generated/geometry/qgsgeometry.sip.in index 7e6d3a3056dd..449e6c591bbb 100644 --- a/python/PyQt6/core/auto_generated/geometry/qgsgeometry.sip.in +++ b/python/PyQt6/core/auto_generated/geometry/qgsgeometry.sip.in @@ -650,10 +650,10 @@ and the indices of the vertices before and after the closest vertex. :param point: point to search for :return: - closest point in geometry. If not found (empty geometry), returns null point and sqrDist is negative. - - closestVertexIndex: will be set to the vertex index of the closest found vertex - - previousVertexIndex: will be set to the vertex index of the previous vertex from the closest one. Will be set to -1 if not present. - - nextVertexIndex: will be set to the vertex index of the next vertex after the closest one. Will be set to -1 if not present. - - sqrDist: will be set to the square distance between the closest vertex and the specified point + - closestVertexIndex: the vertex index of the closest found vertex + - previousVertexIndex: the vertex index of the previous vertex from the closest one. Will be set to -1 if not present. + - nextVertexIndex: the vertex index of the next vertex after the closest one. Will be set to -1 if not present. + - sqrDist: the square distance between the closest vertex and the specified point %End double distanceToVertex( int vertex ) const; diff --git a/python/PyQt6/core/auto_generated/geometry/qgsgeometryengine.sip.in b/python/PyQt6/core/auto_generated/geometry/qgsgeometryengine.sip.in index b612808f8985..a38023ecdd4a 100644 --- a/python/PyQt6/core/auto_generated/geometry/qgsgeometryengine.sip.in +++ b/python/PyQt6/core/auto_generated/geometry/qgsgeometryengine.sip.in @@ -272,14 +272,14 @@ Determines whether the geometry is simple (according to OGC definition). Splits this geometry according to a given line. :param splitLine: the line that splits the geometry -:param newGeometries: list of new geometries that have been created with the split :param topological: ``True`` if topological editing is enabled :param topologyTestPoints: points that need to be tested for topological completeness in the dataset :param errorMsg: error messages emitted, if any :param skipIntersectionCheck: set to ``True`` to skip the potentially expensive initial intersection check. Only set this flag if an intersection test has already been performed by the caller! -:return: 0 in case of success, 1 if geometry has not been split, error else +:return: - 0 in case of success, 1 if geometry has not been split, error else + - newGeometries: list of new geometries that have been created with the split %End virtual QgsAbstractGeometry *offsetCurve( double distance, int segments, Qgis::JoinStyle joinStyle, double miterLimit, QString *errorMsg = 0 ) const = 0 /Factory/; diff --git a/python/PyQt6/core/auto_generated/geometry/qgsgeometryutils.sip.in b/python/PyQt6/core/auto_generated/geometry/qgsgeometryutils.sip.in index 9a35a8341d6d..8db55ed5e830 100644 --- a/python/PyQt6/core/auto_generated/geometry/qgsgeometryutils.sip.in +++ b/python/PyQt6/core/auto_generated/geometry/qgsgeometryutils.sip.in @@ -61,10 +61,10 @@ Retrieves the vertices which are before and after the interpolated point at a sp :param geometry: line or polygon geometry :param distance: distance to traverse along geometry -:param previousVertex: will be set to previous vertex ID :return: - ``True`` if vertices were successfully retrieved - - nextVertex: will be set to next vertex ID + - previousVertex: previous vertex ID + - nextVertex: next vertex ID .. note:: @@ -808,12 +808,13 @@ The result is a line (segment) centered in point p and perpendicular to segment :param segmentPoint1y: : y-coordinate of segmentPoint1, the segment's start point :param segmentPoint2x: : x-coordinate of segmentPoint2, the segment's end point :param segmentPoint2y: : y-coordinate of segmentPoint2, the segment's end point -:param perpendicularSegmentPoint1x: : x-coordinate of the perpendicularCenterSegment's start point -:param perpendicularSegmentPoint1y: : y-coordinate of the perpendicularCenterSegment's start point -:param perpendicularSegmentPoint2x: : x-coordinate of the perpendicularCenterSegment's end point -:param perpendicularSegmentPoint2y: : y-coordinate of the perpendicularCenterSegment's end point :param segmentLength: (optional) Trims to given length. A segmentLength value of 0 refers to the default length which is double the length of the input segment. Set to 1 for a normalized length. +:return: - perpendicularSegmentPoint1x: : x-coordinate of the perpendicularCenterSegment's start point + - perpendicularSegmentPoint1y: : y-coordinate of the perpendicularCenterSegment's start point + - perpendicularSegmentPoint2x: : x-coordinate of the perpendicularCenterSegment's end point + - perpendicularSegmentPoint2y: : y-coordinate of the perpendicularCenterSegment's end point + .. versionadded:: 3.24 .. deprecated:: 3.40 @@ -848,10 +849,10 @@ A method to project one skew line onto another. :param P12: is the second point that belongs to first skew line, :param P2: is the first point that belongs to second skew line, :param P22: is the second point that belongs to second skew line, -:param X1: is the result projection point of line P2P22 onto line P1P12, :param epsilon: the tolerance to use. -:return: ``True`` if such point exists, ``False`` - otherwise. +:return: - ``True`` if such point exists, ``False`` - otherwise. + - X1: is the result projection point of line P2P22 onto line P1P12, .. deprecated:: 3.40 diff --git a/python/PyQt6/core/auto_generated/geometry/qgsgeometryutils_base.sip.in b/python/PyQt6/core/auto_generated/geometry/qgsgeometryutils_base.sip.in index 25d7ea6fbc62..012c66b0e4f5 100644 --- a/python/PyQt6/core/auto_generated/geometry/qgsgeometryutils_base.sip.in +++ b/python/PyQt6/core/auto_generated/geometry/qgsgeometryutils_base.sip.in @@ -257,12 +257,13 @@ The result is a line (segment) centered in point p and perpendicular to segment :param segmentPoint1y: : y-coordinate of segmentPoint1, the segment's start point :param segmentPoint2x: : x-coordinate of segmentPoint2, the segment's end point :param segmentPoint2y: : y-coordinate of segmentPoint2, the segment's end point -:param perpendicularSegmentPoint1x: : x-coordinate of the perpendicularCenterSegment's start point -:param perpendicularSegmentPoint1y: : y-coordinate of the perpendicularCenterSegment's start point -:param perpendicularSegmentPoint2x: : x-coordinate of the perpendicularCenterSegment's end point -:param perpendicularSegmentPoint2y: : y-coordinate of the perpendicularCenterSegment's end point :param segmentLength: (optional) Trims to given length. A segmentLength value of 0 refers to the default length which is double the length of the input segment. Set to 1 for a normalized length. +:return: - perpendicularSegmentPoint1x: : x-coordinate of the perpendicularCenterSegment's start point + - perpendicularSegmentPoint1y: : y-coordinate of the perpendicularCenterSegment's start point + - perpendicularSegmentPoint2x: : x-coordinate of the perpendicularCenterSegment's end point + - perpendicularSegmentPoint2y: : y-coordinate of the perpendicularCenterSegment's end point + .. versionadded:: 3.24 %End @@ -290,10 +291,10 @@ A method to project one skew line onto another. :param P12: is the second point that belongs to first skew line, :param P2: is the first point that belongs to second skew line, :param P22: is the second point that belongs to second skew line, -:param X1: is the result projection point of line P2P22 onto line P1P12, :param epsilon: the tolerance to use. -:return: ``True`` if such point exists, ``False`` - otherwise. +:return: - ``True`` if such point exists, ``False`` - otherwise. + - X1: is the result projection point of line P2P22 onto line P1P12, %End static bool linesIntersection3D( const QgsVector3D &La1, const QgsVector3D &La2, diff --git a/python/PyQt6/core/auto_generated/gps/qgsgpsinformation.sip.in b/python/PyQt6/core/auto_generated/gps/qgsgpsinformation.sip.in index 6e82579f0462..ea305ac159bf 100644 --- a/python/PyQt6/core/auto_generated/gps/qgsgpsinformation.sip.in +++ b/python/PyQt6/core/auto_generated/gps/qgsgpsinformation.sip.in @@ -71,7 +71,7 @@ Returns the best fix status and corresponding constellation. :return: - best current fix status - - constellation: will be set to the constellation with best fix status + - constellation: the constellation with best fix status .. versionadded:: 3.30 %End diff --git a/python/PyQt6/core/auto_generated/numericformats/qgsfractionnumericformat.sip.in b/python/PyQt6/core/auto_generated/numericformats/qgsfractionnumericformat.sip.in index fde86d3362f6..58b5a3d8d903 100644 --- a/python/PyQt6/core/auto_generated/numericformats/qgsfractionnumericformat.sip.in +++ b/python/PyQt6/core/auto_generated/numericformats/qgsfractionnumericformat.sip.in @@ -135,9 +135,9 @@ This method is based of Richard's algorithm (1981) from "Continued Fractions wit :param tolerance: acceptable tolerance. Larger values will give "nicer" fractions. :return: - ``True`` if ``value`` was successfully converted to a fraction - - numerator: will be set to calculated fraction numerator - - denominator: will be set to the calculated fraction denominator - - sign: will be set to the sign of the result (as -1 or +1 values) + - numerator: calculated fraction numerator + - denominator: the calculated fraction denominator + - sign: the sign of the result (as -1 or +1 values) %End static QString toUnicodeSuperscript( const QString &input ); diff --git a/python/PyQt6/core/auto_generated/painting/qgspainting.sip.in b/python/PyQt6/core/auto_generated/painting/qgspainting.sip.in index 03d1b16c2d39..466a1d9412ca 100644 --- a/python/PyQt6/core/auto_generated/painting/qgspainting.sip.in +++ b/python/PyQt6/core/auto_generated/painting/qgspainting.sip.in @@ -60,7 +60,7 @@ to the triangle defined by (``outX1``, ``outY1``), (``outY2``, ``outY2``), (``ou :param outY3: destination triangle vertex 3 y-coordinate :return: - Calculated transform (if possible) - - ok: will be set to ``True`` if the transform could be determined. + - ok: ``True`` if the transform could be determined. .. versionadded:: 3.34 %End diff --git a/python/PyQt6/core/auto_generated/processing/models/qgsprocessingmodelalgorithm.sip.in b/python/PyQt6/core/auto_generated/processing/models/qgsprocessingmodelalgorithm.sip.in index 0c6e269be00d..bdaa3285fffa 100644 --- a/python/PyQt6/core/auto_generated/processing/models/qgsprocessingmodelalgorithm.sip.in +++ b/python/PyQt6/core/auto_generated/processing/models/qgsprocessingmodelalgorithm.sip.in @@ -78,7 +78,7 @@ Validates the model, returning ``True`` if all child algorithms in the model are :return: - ``True`` if the child is valid - - issues: will be set to a list of issues encountered during the validation + - issues: a list of issues encountered during the validation .. versionadded:: 3.14 %End @@ -211,7 +211,7 @@ all mandatory inputs to the algorithm have valid values. :param childId: ID for child to validate :return: - ``True`` if the child is valid - - issues: will be set to a list of issues encountered during the validation + - issues: a list of issues encountered during the validation .. versionadded:: 3.14 %End diff --git a/python/PyQt6/core/auto_generated/processing/qgsprocessingalgorithm.sip.in b/python/PyQt6/core/auto_generated/processing/qgsprocessingalgorithm.sip.in index 037f507187f1..d03819a77452 100644 --- a/python/PyQt6/core/auto_generated/processing/qgsprocessingalgorithm.sip.in +++ b/python/PyQt6/core/auto_generated/processing/qgsprocessingalgorithm.sip.in @@ -442,7 +442,7 @@ Note that some combinations of parameter types and values cannot be represented :param context: processing context :return: - equivalent qgis_process command - - ok: will be set to ``True`` if the command was successfully generated + - ok: ``True`` if the command was successfully generated .. versionadded:: 3.24 %End @@ -777,7 +777,7 @@ a conversion in this case and will return the target layer name in the ``layerNa :param feedback: feedback object :return: - path to source layer, or nearly converted compatible layer - - layerName: will be set to the target layer name for multi-layer sources (e.g. Geopackage) + - layerName: the target layer name for multi-layer sources (e.g. Geopackage) .. seealso:: :py:func:`parameterAsCompatibleSourceLayerPath` diff --git a/python/PyQt6/core/auto_generated/processing/qgsprocessingoutputs.sip.in b/python/PyQt6/core/auto_generated/processing/qgsprocessingoutputs.sip.in index 57b147a3b226..bc5de415cdc2 100644 --- a/python/PyQt6/core/auto_generated/processing/qgsprocessingoutputs.sip.in +++ b/python/PyQt6/core/auto_generated/processing/qgsprocessingoutputs.sip.in @@ -131,7 +131,7 @@ Returns a string version of the parameter output ``value`` (if possible). :param context: processing context :return: - value converted to string - - ok: will be set to ``True`` if value could be represented as a string. + - ok: ``True`` if value could be represented as a string. .. seealso:: :py:func:`valueAsFormattedString` @@ -148,7 +148,7 @@ By default this will return the same value as :py:func:`~QgsProcessingOutputDefi :param context: processing context :return: - value converted to string - - ok: will be set to ``True`` if value could be represented as a string. + - ok: ``True`` if value could be represented as a string. .. seealso:: :py:func:`valueAsString` diff --git a/python/PyQt6/core/auto_generated/processing/qgsprocessingparameters.sip.in b/python/PyQt6/core/auto_generated/processing/qgsprocessingparameters.sip.in index a2de59ce1eb6..d2855bf7adca 100644 --- a/python/PyQt6/core/auto_generated/processing/qgsprocessingparameters.sip.in +++ b/python/PyQt6/core/auto_generated/processing/qgsprocessingparameters.sip.in @@ -534,7 +534,7 @@ Returns a string version of the parameter input ``value`` (if possible). :param context: processing context :return: - value converted to string - - ok: will be set to ``True`` if value could be represented as a string. + - ok: ``True`` if value could be represented as a string. .. seealso:: :py:func:`valueAsStringList` @@ -553,7 +553,7 @@ Returns a string list version of the parameter input ``value`` (if possible). :param context: processing context :return: - value converted to string list - - ok: will be set to ``True`` if value could be represented as a string list + - ok: ``True`` if value could be represented as a string list .. seealso:: :py:func:`valueAsString` @@ -1140,7 +1140,7 @@ a conversion in this case and will return the target layer name in the ``layerNa :param feedback: feedback object :return: - path to source layer, or nearly converted compatible layer - - layerName: will be set to the target layer name for multi-layer sources (e.g. Geopackage) + - layerName: the target layer name for multi-layer sources (e.g. Geopackage) .. seealso:: :py:func:`parameterAsCompatibleSourceLayerPath` @@ -3507,7 +3507,7 @@ calls :py:func:`QgsProcessingProvider.isSupportedOutputValue()` to test compatib :param context: Processing context :return: - ``True`` if ``value`` is supported. - - error: will be set to a descriptive error string + - error: a descriptive error string .. versionadded:: 3.14 %End diff --git a/python/PyQt6/core/auto_generated/processing/qgsprocessingutils.sip.in b/python/PyQt6/core/auto_generated/processing/qgsprocessingutils.sip.in index c8d60c5fe25c..64dede43c35f 100644 --- a/python/PyQt6/core/auto_generated/processing/qgsprocessingutils.sip.in +++ b/python/PyQt6/core/auto_generated/processing/qgsprocessingutils.sip.in @@ -504,11 +504,11 @@ a conversion in this case and will return the target layer name in the ``layerNa :param preferredFormat: preferred format extension to use if conversion if required :param context: processing context :param feedback: feedback object -:param layerName: will be set to the target layer name for multi-layer sources (e.g. Geopackage) :param featureLimit: can be used to place a limit on the maximum number of features read from the layer :param filterExpression: optional expression for filtering features read from the layer (since QGIS 3.32) -:return: path to source layer, or nearly converted compatible layer +:return: - path to source layer, or nearly converted compatible layer + - layerName: the target layer name for multi-layer sources (e.g. Geopackage) .. seealso:: :py:func:`convertToCompatibleFormat` diff --git a/python/PyQt6/core/auto_generated/proj/qgscoordinatereferencesystem.sip.in b/python/PyQt6/core/auto_generated/proj/qgscoordinatereferencesystem.sip.in index c215b3928092..492ab84ca825 100644 --- a/python/PyQt6/core/auto_generated/proj/qgscoordinatereferencesystem.sip.in +++ b/python/PyQt6/core/auto_generated/proj/qgscoordinatereferencesystem.sip.in @@ -323,7 +323,7 @@ or the compound CRS could not be created for the combination. :param verticalCrs: vertical component for CRS :return: - compound CRS if it was possible to create one, or an invalid CRS if not - - error: will be set to a descriptive error if the compound CRS could not be created + - error: a descriptive error if the compound CRS could not be created .. versionadded:: 3.38 %End diff --git a/python/PyQt6/core/auto_generated/project/qgsproject.sip.in b/python/PyQt6/core/auto_generated/project/qgsproject.sip.in index 8c53374adc1c..f80e78bc4279 100644 --- a/python/PyQt6/core/auto_generated/project/qgsproject.sip.in +++ b/python/PyQt6/core/auto_generated/project/qgsproject.sip.in @@ -426,7 +426,7 @@ The :py:func:`~QgsProject.verticalCrsChanged` signal will be raised if the verti :param crs: the vertical CRS :return: - ``True`` if vertical CRS was successfully set - - errorMessage: will be set to a descriptive message if the vertical CRS could not be set + - errorMessage: a descriptive message if the vertical CRS could not be set .. seealso:: :py:func:`verticalCrs` @@ -2246,7 +2246,7 @@ that the user has some chance of repairing the damage cleanly. parameter is not mandatory, as the changes from all layers will be committed. :return: - ``True`` if the commit was successful. - - commitErrors: will be set to a list of descriptive errors if the commit fails. + - commitErrors: a list of descriptive errors if the commit fails. .. seealso:: :py:func:`startEditing` @@ -2265,7 +2265,7 @@ Stops a current editing operation on vectorLayer and discards any uncommitted ed parameter is not mandatory, as the changes from all layers will be rolled back. :return: - ``True`` if the rollback was successful. - - rollbackErrors: will be set to a list of descriptive errors if the rollback fails. + - rollbackErrors: a list of descriptive errors if the rollback fails. .. seealso:: :py:func:`startEditing` diff --git a/python/PyQt6/core/auto_generated/providers/arcgis/qgsarcgisrestutils.sip.in b/python/PyQt6/core/auto_generated/providers/arcgis/qgsarcgisrestutils.sip.in index fc20543b7379..3d89c6d89437 100644 --- a/python/PyQt6/core/auto_generated/providers/arcgis/qgsarcgisrestutils.sip.in +++ b/python/PyQt6/core/auto_generated/providers/arcgis/qgsarcgisrestutils.sip.in @@ -96,7 +96,7 @@ Caller takes ownership of the returned object. :param hasZ: set to ``True`` to if geometry includes Z values :return: - converted geometry - - crs: will be set to the parsed geometry CRS + - crs: the parsed geometry CRS %End static QgsCoordinateReferenceSystem convertSpatialReference( const QVariantMap &spatialReferenceMap ); diff --git a/python/PyQt6/core/auto_generated/providers/qgsprovidermetadata.sip.in b/python/PyQt6/core/auto_generated/providers/qgsprovidermetadata.sip.in index dcc4218d406b..4a11be02b5d9 100644 --- a/python/PyQt6/core/auto_generated/providers/qgsprovidermetadata.sip.in +++ b/python/PyQt6/core/auto_generated/providers/qgsprovidermetadata.sip.in @@ -439,7 +439,7 @@ metadata :py:func:`~QgsProviderMetadata.createDatabase` method can be used to cr :param uri: destination URI for newly created database. :return: - ``True`` if the database was successfully created - - errorMessage: will be set to a descriptive error message if the database could not be successfully created. + - errorMessage: a descriptive error message if the database could not be successfully created. .. note:: @@ -606,7 +606,7 @@ Returns ``True`` if a layer style with the specified ``styleId`` exists in the p :param styleId: style ID to test for :return: - ``True`` if the layer style already exists - - errorCause: will be set to a descriptive error message, if an error occurs while checking if the style exists + - errorCause: a descriptive error message, if an error occurs while checking if the style exists .. seealso:: :py:func:`getStyleById` diff --git a/python/PyQt6/core/auto_generated/providers/qgsproviderregistry.sip.in b/python/PyQt6/core/auto_generated/providers/qgsproviderregistry.sip.in index 0823081a346a..17bd4115b300 100644 --- a/python/PyQt6/core/auto_generated/providers/qgsproviderregistry.sip.in +++ b/python/PyQt6/core/auto_generated/providers/qgsproviderregistry.sip.in @@ -250,7 +250,7 @@ Returns ``True`` if a layer style with the specified ``styleId`` exists in the p :param styleId: style ID to test for :return: - ``True`` if the layer style already exists - - errorCause: will be set to a descriptive error message, if an error occurs while checking if the style exists + - errorCause: a descriptive error message, if an error occurs while checking if the style exists .. seealso:: :py:func:`getStyleById` diff --git a/python/PyQt6/core/auto_generated/providers/sensorthings/qgssensorthingsutils.sip.in b/python/PyQt6/core/auto_generated/providers/sensorthings/qgssensorthingsutils.sip.in index 6ad7a5f23030..45b049c4c7e4 100644 --- a/python/PyQt6/core/auto_generated/providers/sensorthings/qgssensorthingsutils.sip.in +++ b/python/PyQt6/core/auto_generated/providers/sensorthings/qgssensorthingsutils.sip.in @@ -136,7 +136,7 @@ Returns the cardinality of the relationship between a base entity type and a rel :param relatedType: related entity type :return: - relationship cardinality - - valid: will be set to ``True`` if a relationship exists between the entity types, or ``False`` if no relationship exists + - valid: ``True`` if a relationship exists between the entity types, or ``False`` if no relationship exists .. versionadded:: 3.38 %End diff --git a/python/PyQt6/core/auto_generated/qgsbookmarkmanager.sip.in b/python/PyQt6/core/auto_generated/qgsbookmarkmanager.sip.in index 7d4d4b302f81..4b19616797bb 100644 --- a/python/PyQt6/core/auto_generated/qgsbookmarkmanager.sip.in +++ b/python/PyQt6/core/auto_generated/qgsbookmarkmanager.sip.in @@ -190,7 +190,7 @@ Adds a ``bookmark`` to the manager. :param bookmark: the bookmark to add :return: - The bookmark's ID (or newly generated ID, if no ID was originally set and one was automatically generated) - - ok: will be set to ``True`` if the bookmark was successfully added, or ``False`` if the bookmark could not be added (eg as a result of a duplicate bookmark ID). + - ok: ``True`` if the bookmark was successfully added, or ``False`` if the bookmark could not be added (eg as a result of a duplicate bookmark ID). .. seealso:: :py:func:`removeBookmark` diff --git a/python/PyQt6/core/auto_generated/qgsdistancearea.sip.in b/python/PyQt6/core/auto_generated/qgsdistancearea.sip.in index 3a5641f08281..aa190111c3b4 100644 --- a/python/PyQt6/core/auto_generated/qgsdistancearea.sip.in +++ b/python/PyQt6/core/auto_generated/qgsdistancearea.sip.in @@ -372,7 +372,7 @@ will also be in this same CRS. :param p2: Ending point, in :py:func:`~QgsDistanceArea.ellipsoidCrs` :return: - the latitude at which the geodesic crosses the antimeridian - - fractionAlongLine: will be set to the fraction along the geodesic line joining ``p1`` to ``p2`` at which the antimeridian crossing occurs. + - fractionAlongLine: the fraction along the geodesic line joining ``p1`` to ``p2`` at which the antimeridian crossing occurs. .. seealso:: :py:func:`splitGeometryAtAntimeridian` diff --git a/python/PyQt6/core/auto_generated/qgsfileutils.sip.in b/python/PyQt6/core/auto_generated/qgsfileutils.sip.in index a4d61aa20bf7..e8383fcec0e2 100644 --- a/python/PyQt6/core/auto_generated/qgsfileutils.sip.in +++ b/python/PyQt6/core/auto_generated/qgsfileutils.sip.in @@ -173,7 +173,7 @@ desired. :param flags: optional flags to control file operation behavior :return: - ``True`` if the dataset was successfully renamed, or ``False`` if an error occurred - - error: will be set to a descriptive error message if the rename operation fails + - error: a descriptive error message if the rename operation fails .. versionadded:: 3.22 %End diff --git a/python/PyQt6/core/auto_generated/qgsimagecache.sip.in b/python/PyQt6/core/auto_generated/qgsimagecache.sip.in index c98efcdb8892..29defb661ac7 100644 --- a/python/PyQt6/core/auto_generated/qgsimagecache.sip.in +++ b/python/PyQt6/core/auto_generated/qgsimagecache.sip.in @@ -70,7 +70,7 @@ size, and then the result cached for subsequent lookups. animations. This should be set to -1 if not required. :return: - rendered image - - fitsInCache: will be set to ``True`` if the resultant raster was of a sufficiently small size to store in the cache + - fitsInCache: ``True`` if the resultant raster was of a sufficiently small size to store in the cache %End QSize originalSize( const QString &path, bool blocking = false ) const; diff --git a/python/PyQt6/core/auto_generated/qgslayerdefinition.sip.in b/python/PyQt6/core/auto_generated/qgslayerdefinition.sip.in index 0225bb7c0498..3ca840f2451b 100644 --- a/python/PyQt6/core/auto_generated/qgslayerdefinition.sip.in +++ b/python/PyQt6/core/auto_generated/qgslayerdefinition.sip.in @@ -67,7 +67,7 @@ for control over this setting. :param selectedTreeNodes: layer tree nodes to include in the QLR file :return: - ``True`` if the export was successful - - errorMessage: will be set to any error messages generated during the export + - errorMessage: any error messages generated during the export %End static bool exportLayerDefinition( const QString &path, const QList &selectedTreeNodes, Qgis::FilePathType pathType, QString &errorMessage /Out/ ); @@ -79,7 +79,7 @@ Exports the selected layer tree nodes to a QLR file. :param pathType: specifies whether absolute or relative file paths should be used. :return: - ``True`` if the export was successful - - errorMessage: will be set to any error messages generated during the export + - errorMessage: any error messages generated during the export .. versionadded:: 3.22 %End diff --git a/python/PyQt6/core/auto_generated/qgsmaplayer.sip.in b/python/PyQt6/core/auto_generated/qgsmaplayer.sip.in index 5f8473976d79..fe2dddb4ee28 100644 --- a/python/PyQt6/core/auto_generated/qgsmaplayer.sip.in +++ b/python/PyQt6/core/auto_generated/qgsmaplayer.sip.in @@ -752,12 +752,12 @@ Read all custom properties from layer. Properties are stored in a map and saved %Docstring Lists all the style in db split into related to the layer and not related to -:param ids: the list in which will be stored the style db ids -:param names: the list in which will be stored the style names :return: - the number of styles related to current layer (-1 on not implemented) + - ids: the list in which will be stored the style db ids + - names: the list in which will be stored the style names - descriptions: the list in which will be stored the style descriptions - - msgError: will be set to a descriptive error message if any occurs + - msgError: a descriptive error message if any occurs .. note:: @@ -776,7 +776,7 @@ Deletes a style from the database :param styleId: the provider's layer_styles table id of the style to delete :return: - ``True`` in case of success - - msgError: will be set to a descriptive error message if any occurs + - msgError: a descriptive error message if any occurs %End virtual void saveStyleToDatabase( const QString &name, const QString &description, @@ -790,7 +790,6 @@ Saves named and sld style of the layer to the style table in the db. :param description: A description of the style :param useAsDefault: Set to ``True`` if style should be used as the default style for the layer :param uiFileContent: -:param msgError: will be set to a descriptive error message if any occurs :param categories: the style categories to be saved. .. note:: @@ -811,10 +810,12 @@ Saves named and sld style of the layer to the style table in the db. Loads a named style from file/local db/datasource db :param theURI: the URI of the style or the URI of the layer -:param resultFlag: will be set to ``True`` if a named style is correctly loaded :param loadFromLocalDb: if ``True`` forces to load from local db instead of datasource one :param categories: the style categories to be loaded. :param flags: flags controlling how the style should be loaded (since QGIS 3.38) + +:return: - status message, which may indicate success or contain an error message + - resultFlag: ``True`` if a named style is correctly loaded %End @@ -928,7 +929,7 @@ The :py:func:`~QgsMapLayer.verticalCrsChanged` signal will be raised if the vert :param crs: the vertical CRS :return: - ``True`` if vertical CRS was successfully set - - errorMessage: will be set to a descriptive message if the vertical CRS could not be set + - errorMessage: a descriptive message if the vertical CRS could not be set .. seealso:: :py:func:`verticalCrs` @@ -976,7 +977,7 @@ record in the users style table in their personal qgis.db) :return: - a QString with any status messages - - resultFlag: a reference to a flag that will be set to ``False`` if we did not manage to save the default metadata. + - resultFlag: a reference to a flag that ``False`` if we did not manage to save the default metadata. %End QString saveNamedMetadata( const QString &uri, bool &resultFlag ); @@ -1010,7 +1011,7 @@ record in the users style table in their personal qgis.db) key matches the URI. :return: - a QString with any status messages - - resultFlag: a reference to a flag that will be set to ``False`` if we did not manage to load the default metadata. + - resultFlag: a reference to a flag that ``False`` if we did not manage to load the default metadata. %End @@ -1069,7 +1070,7 @@ record in the users style table in their personal qgis.db) :return: - a QString with any status messages - - resultFlag: a reference to a flag that will be set to ``False`` if we did not manage to load the default style. + - resultFlag: a reference to a flag that ``False`` if we did not manage to load the default style. .. seealso:: :py:func:`loadNamedStyle` %End @@ -1090,7 +1091,7 @@ record in the users style table in their personal qgis.db) :param flags: flags controlling how the style should be loaded (since QGIS 3.38) :return: - a QString with any status messages - - resultFlag: a reference to a flag that will be set to ``False`` if we did not manage to load the default style. + - resultFlag: a reference to a flag that ``False`` if we did not manage to load the default style. .. seealso:: :py:func:`loadDefaultStyle` %End @@ -1103,7 +1104,7 @@ Retrieve a named style for this layer from a sqlite database. :param uri: uri for table :return: - ``True`` if style was successfully loaded - - qml: will be set to QML style content from database + - qml: QML style content from database %End virtual bool importNamedStyle( QDomDocument &doc, QString &errorMsg /Out/, @@ -1112,11 +1113,10 @@ Retrieve a named style for this layer from a sqlite database. Import the properties of this layer from a QDomDocument :param doc: source QDomDocument -:param errorMsg: this QString will be initialized on error - during the execution of readSymbology :param categories: the style categories to import -:return: ``True`` on success +:return: - ``True`` on success + - errorMsg: this QString will be initialized on error during the execution of readSymbology %End virtual void exportNamedStyle( QDomDocument &doc, QString &errorMsg /Out/, const QgsReadWriteContext &context = QgsReadWriteContext(), @@ -1125,7 +1125,6 @@ Import the properties of this layer from a QDomDocument Export the properties of this layer as named style in a QDomDocument :param doc: the target QDomDocument -:param errorMsg: this QString will be initialized on error :param context: read write context :param categories: the style categories to export during the execution of writeSymbology @@ -1164,7 +1163,7 @@ record in the users style table in their personal qgis.db) :param categories: the style categories to be saved (since QGIS 3.26) :return: - a QString with any status messages - - resultFlag: a reference to a flag that will be set to ``False`` if we did not manage to save the default style. + - resultFlag: a reference to a flag that ``False`` if we did not manage to save the default style. .. seealso:: :py:func:`loadNamedStyle` @@ -1179,7 +1178,7 @@ record in the users style table in their personal qgis.db) :return: - a QString with any status messages - - resultFlag: a reference to a flag that will be set to ``False`` if we did not manage to save the default style. + - resultFlag: a reference to a flag that ``False`` if we did not manage to save the default style. .. seealso:: :py:func:`loadNamedStyle` @@ -1202,7 +1201,7 @@ record in the users style table in their personal qgis.db) :param categories: the style categories to be saved. :return: - a QString with any status messages - - resultFlag: a reference to a flag that will be set to ``False`` if we did not manage to save the default style. + - resultFlag: a reference to a flag that ``False`` if we did not manage to save the default style. .. seealso:: :py:func:`saveDefaultStyle` %End @@ -1229,7 +1228,7 @@ Saves the properties of this layer to an SLD format file. :param exportContext: SLD export context :return: - a string with any status or error messages - - resultFlag: a reference to a flag that will be set to ``False`` if the SLD file could not be generated + - resultFlag: a reference to a flag that ``False`` if the SLD file could not be generated .. seealso:: :py:func:`loadSldStyle` diff --git a/python/PyQt6/core/auto_generated/qgsmaplayerfactory.sip.in b/python/PyQt6/core/auto_generated/qgsmaplayerfactory.sip.in index 5931ae7c6d1a..26964f5154f8 100644 --- a/python/PyQt6/core/auto_generated/qgsmaplayerfactory.sip.in +++ b/python/PyQt6/core/auto_generated/qgsmaplayerfactory.sip.in @@ -32,7 +32,7 @@ Returns the map layer type corresponding a ``string`` value. :param string: string to convert to map layer type :return: - converted map layer type - - ok: will be set to ``True`` if ``string`` was successfully converted to a map layer type + - ok: ``True`` if ``string`` was successfully converted to a map layer type .. seealso:: :py:func:`typeToString` %End diff --git a/python/PyQt6/core/auto_generated/qgsmultirenderchecker.sip.in b/python/PyQt6/core/auto_generated/qgsmultirenderchecker.sip.in index 8fd050961a60..fa8482cbe173 100644 --- a/python/PyQt6/core/auto_generated/qgsmultirenderchecker.sip.in +++ b/python/PyQt6/core/auto_generated/qgsmultirenderchecker.sip.in @@ -198,7 +198,7 @@ page in the layout. :param createReferenceImage: if ``True``, the rendered reference image will be regenerated instead of performing a comparison test with the existing image :return: - ``True`` if the rendered layout matches the expected reference image. - - report: will be set to generated test report + - report: generated test report %End }; diff --git a/python/PyQt6/core/auto_generated/qgsproperty.sip.in b/python/PyQt6/core/auto_generated/qgsproperty.sip.in index 06820ccff020..ebd86ff4d382 100644 --- a/python/PyQt6/core/auto_generated/qgsproperty.sip.in +++ b/python/PyQt6/core/auto_generated/qgsproperty.sip.in @@ -253,7 +253,7 @@ a fixed value expression ('some static value'), this method will return :param context: expression context :return: - ``True`` if property is a static value - - staticValue: will be set to evaluated static value if property is effectively a static value + - staticValue: evaluated static value if property is effectively a static value .. versionadded:: 3.24 %End @@ -355,7 +355,7 @@ Calculates the current value of the property, including any transforms which are :param defaultValue: default value to return if the property is not active or cannot be calculated :return: - calculated value for property - - ok: will be set to ``True`` if conversion was successful + - ok: ``True`` if conversion was successful .. seealso:: :py:func:`valueAsString` @@ -376,7 +376,7 @@ Calculates the current value of the property and interprets it as a datetime. :param defaultDateTime: default datetime to return if the property cannot be calculated as a datetime :return: - value parsed to datetime - - ok: will be set to ``True`` if conversion was successful + - ok: ``True`` if conversion was successful .. seealso:: :py:func:`value` @@ -401,7 +401,7 @@ Calculates the current value of the property and interprets it as a string. :param defaultString: default string to return if the property cannot be calculated as a string :return: - value parsed to string - - ok: will be set to ``True`` if conversion was successful + - ok: ``True`` if conversion was successful .. seealso:: :py:func:`value` @@ -424,7 +424,7 @@ Calculates the current value of the property and interprets it as a color. :param defaultColor: default color to return if the property cannot be calculated as a color :return: - value parsed to color - - ok: will be set to ``True`` if conversion was successful + - ok: ``True`` if conversion was successful .. seealso:: :py:func:`value` @@ -447,7 +447,7 @@ Calculates the current value of the property and interprets it as a double. :param defaultValue: default double to return if the property cannot be calculated as a double :return: - value parsed to double - - ok: will be set to ``True`` if conversion was successful + - ok: ``True`` if conversion was successful .. seealso:: :py:func:`value` @@ -470,7 +470,7 @@ Calculates the current value of the property and interprets it as an integer. :param defaultValue: default integer to return if the property cannot be calculated as an integer :return: - value parsed to integer - - ok: will be set to ``True`` if conversion was successful + - ok: ``True`` if conversion was successful .. seealso:: :py:func:`value` @@ -493,7 +493,7 @@ Calculates the current value of the property and interprets it as an boolean. :param defaultValue: default boolean to return if the property cannot be calculated as an boolean :return: - value parsed to boolean - - ok: will be set to ``True`` if conversion was successful + - ok: ``True`` if conversion was successful .. seealso:: :py:func:`value` diff --git a/python/PyQt6/core/auto_generated/qgspropertycollection.sip.in b/python/PyQt6/core/auto_generated/qgspropertycollection.sip.in index b738acc12719..a5c7fc86e4c6 100644 --- a/python/PyQt6/core/auto_generated/qgspropertycollection.sip.in +++ b/python/PyQt6/core/auto_generated/qgspropertycollection.sip.in @@ -120,7 +120,7 @@ Calculates the current value of the property with the specified key and interpre :param defaultDateTime: default datetime to return if the property cannot be calculated as a datetime :return: - value parsed to datetime - - ok: will be set to ``True`` if conversion was successful + - ok: ``True`` if conversion was successful .. seealso:: :py:func:`value` @@ -147,7 +147,7 @@ Calculates the current value of the property with the specified key and interpre :param defaultString: default string to return if the property cannot be calculated as a string :return: - value parsed to string - - ok: will be set to ``True`` if conversion was successful + - ok: ``True`` if conversion was successful .. seealso:: :py:func:`value` @@ -172,7 +172,7 @@ Calculates the current value of the property with the specified key and interpre :param defaultColor: default color to return if the property cannot be calculated as a color :return: - value parsed to color - - ok: will be set to ``True`` if conversion was successful + - ok: ``True`` if conversion was successful .. seealso:: :py:func:`value` @@ -197,7 +197,7 @@ Calculates the current value of the property with the specified key and interpre :param defaultValue: default double to return if the property cannot be calculated as a double :return: - value parsed to double - - ok: will be set to ``True`` if conversion was successful + - ok: ``True`` if conversion was successful .. seealso:: :py:func:`value` @@ -222,7 +222,7 @@ Calculates the current value of the property with the specified key and interpre :param defaultValue: default integer to return if the property cannot be calculated as a integer :return: - value parsed to integer - - ok: will be set to ``True`` if conversion was successful + - ok: ``True`` if conversion was successful .. seealso:: :py:func:`value` @@ -247,7 +247,7 @@ Calculates the current value of the property with the specified key and interpre :param defaultValue: default boolean to return if the property cannot be calculated as a boolean :return: - value parsed to bool - - ok: will be set to ``True`` if conversion was successful + - ok: ``True`` if conversion was successful .. seealso:: :py:func:`value` diff --git a/python/PyQt6/core/auto_generated/qgspropertytransformer.sip.in b/python/PyQt6/core/auto_generated/qgspropertytransformer.sip.in index 1ae34db99feb..cff8ad9f0285 100644 --- a/python/PyQt6/core/auto_generated/qgspropertytransformer.sip.in +++ b/python/PyQt6/core/auto_generated/qgspropertytransformer.sip.in @@ -287,8 +287,8 @@ Attempts to parse an expression into a corresponding property transformer. :param expression: expression to parse :return: - corresponding property transformer, or ``None`` if expression could not be parsed to a transformer. - - baseExpression: will be set to the component of the source expression which is used to calculate the input to the property transformer. This will be set to an empty string if a field reference is the transformer input. - - fieldName: will be set to a field name which is used to calculate the input to the property transformer. This will be set to an empty string if an expression is the transformer input. + - baseExpression: the component of the source expression which is used to calculate the input to the property transformer. This an empty string if a field reference is the transformer input. + - fieldName: a field name which is used to calculate the input to the property transformer. This an empty string if an expression is the transformer input. %End protected: @@ -350,8 +350,8 @@ Attempts to parse an expression into a corresponding :py:class:`QgsSizeScaleTran :return: - corresponding :py:class:`QgsSizeScaleTransformer`, or ``None`` if expression could not be parsed to a size scale transformer. - - baseExpression: will be set to the component of the source expression which is used to calculate the input to the property transformer. This will be set to an empty string if a field reference is the transformer input. - - fieldName: will be set to a field name which is used to calculate the input to the property transformer. This will be set to an empty string if an expression is the transformer input. + - baseExpression: the component of the source expression which is used to calculate the input to the property transformer. This will be set to an empty string if a field reference is the transformer input. + - fieldName: a field name which is used to calculate the input to the property transformer. This will be set to an empty string if an expression is the transformer input. %End double value( double input ) const; @@ -492,8 +492,8 @@ Attempts to parse an expression into a corresponding QgsSizeScaleTransformer. :param expression: expression to parse :return: - corresponding QgsSizeScaleTransformer, or ``None`` if expression could not be parsed to a size scale transformer. - - baseExpression: will be set to the component of the source expression which is used to calculate the input to the property transformer. This will be set to an empty string if a field reference is the transformer input. - - fieldName: will be set to a field name which is used to calculate the input to the property transformer. This will be set to an empty string if an expression is the transformer input. + - baseExpression: the component of the source expression which is used to calculate the input to the property transformer. This an empty string if a field reference is the transformer input. + - fieldName: a field name which is used to calculate the input to the property transformer. This an empty string if an expression is the transformer input. %End double size( double value ) const; diff --git a/python/PyQt6/core/auto_generated/qgstemporalutils.sip.in b/python/PyQt6/core/auto_generated/qgstemporalutils.sip.in index 89877a456e33..541e258f1c80 100644 --- a/python/PyQt6/core/auto_generated/qgstemporalutils.sip.in +++ b/python/PyQt6/core/auto_generated/qgstemporalutils.sip.in @@ -80,7 +80,7 @@ support. :param feedback: optional feedback object for progress reports and cancellation checks :return: - ``True`` if the export was successful. - - error: will be set to a descriptive error message if the export fails + - error: a descriptive error message if the export fails %End static QDateTime calculateFrameTime( const QDateTime &start, const long long frame, const QgsInterval &interval ); @@ -116,8 +116,8 @@ Calculates a complete list of datetimes between ``start`` and ``end``, using the :param maxValues: maximum number of values to return, or -1 to return all values :return: - calculated list of date times - - ok: will be set to ``True`` if ``duration`` was successfully parsed and date times could be calculated - - maxValuesExceeded: will be set to ``True`` if the maximum number of values to return was exceeded + - ok: ``True`` if ``duration`` was successfully parsed and date times could be calculated + - maxValuesExceeded: ``True`` if the maximum number of values to return was exceeded .. versionadded:: 3.20 %End @@ -131,8 +131,8 @@ Calculates a complete list of datetimes from a ISO8601 ``string`` containing a d :param maxValues: maximum number of values to return, or -1 to return all values :return: - calculated list of date times - - ok: will be set to ``True`` if ``string`` was successfully parsed and date times could be calculated - - maxValuesExceeded: will be set to ``True`` if the maximum number of values to return was exceeded + - ok: ``True`` if ``string`` was successfully parsed and date times could be calculated + - maxValuesExceeded: ``True`` if the maximum number of values to return was exceeded .. versionadded:: 3.20 %End diff --git a/python/PyQt6/core/auto_generated/qgsunittypes.sip.in b/python/PyQt6/core/auto_generated/qgsunittypes.sip.in index 06525b7d890e..1a9ad2adf9a4 100644 --- a/python/PyQt6/core/auto_generated/qgsunittypes.sip.in +++ b/python/PyQt6/core/auto_generated/qgsunittypes.sip.in @@ -61,7 +61,7 @@ Decodes a unit type from a ``string``. :param string: string to decode :return: - decoded unit type - - ok: boolean, will be set to ``True`` if string was converted successfully + - ok: boolean, ``True`` if string was converted successfully .. seealso:: :py:func:`encodeUnitType` @@ -93,7 +93,7 @@ Decodes a distance unit from a string. :param string: string to decode :return: - decoded units - - ok: boolean, will be set to ``True`` if string was converted successfully + - ok: boolean, ``True`` if string was converted successfully .. seealso:: :py:func:`encodeUnit` %End @@ -123,7 +123,7 @@ Converts a translated string to a distance unit. :param string: string representing a distance unit :return: - the distance unit - - ok: boolean, will be set to ``True`` if string was converted successfully + - ok: boolean, ``True`` if string was converted successfully .. seealso:: :py:func:`toString` %End @@ -162,7 +162,7 @@ Decodes an areal unit from a string. :param string: string to decode :return: - decoded units - - ok: boolean, will be set to ``True`` if string was converted successfully + - ok: boolean, ``True`` if string was converted successfully .. seealso:: :py:func:`encodeUnit` %End @@ -192,7 +192,7 @@ Converts a translated string to an areal unit. :param string: string representing an areal unit :return: - the area unit - - ok: boolean, will be set to ``True`` if string was converted successfully + - ok: boolean, ``True`` if string was converted successfully .. seealso:: :py:func:`toString` %End @@ -246,7 +246,7 @@ Decodes a temporal unit from a ``string``. :param string: string to decode :return: - decoded units - - ok: boolean, will be set to ``True`` if string was converted successfully + - ok: boolean, ``True`` if string was converted successfully .. seealso:: :py:func:`encodeUnit` @@ -278,7 +278,7 @@ Converts a translated ``string`` to a temporal unit. :param string: string representing a volume unit :return: - the temporal unit - - ok: boolean, will be set to ``True`` if string was converted successfully + - ok: boolean, ``True`` if string was converted successfully .. seealso:: :py:func:`toString` @@ -331,7 +331,7 @@ Decodes a volume unit from a ``string``. :param string: string to decode :return: - decoded units - - ok: boolean, will be set to ``True`` if string was converted successfully + - ok: boolean, ``True`` if string was converted successfully .. seealso:: :py:func:`encodeUnit` @@ -363,7 +363,7 @@ Converts a translated ``string`` to a volume unit. :param string: string representing a volume unit :return: - the volume unit - - ok: boolean, will be set to ``True`` if string was converted successfully + - ok: boolean, ``True`` if string was converted successfully .. seealso:: :py:func:`toString` @@ -423,7 +423,7 @@ Decodes an angular unit from a string. :param string: string to decode :return: - decoded units - - ok: boolean, will be set to ``True`` if string was converted successfully + - ok: boolean, ``True`` if string was converted successfully .. seealso:: :py:func:`encodeUnit` %End @@ -523,7 +523,7 @@ Decodes a render unit from a string. :param string: string to decode :return: - decoded units - - ok: boolean, will be set to ``True`` if string was converted successfully + - ok: boolean, ``True`` if string was converted successfully .. seealso:: :py:func:`encodeUnit` %End @@ -563,7 +563,7 @@ Decodes a layout unit from a string. :param string: string to decode :return: - decoded units - - ok: boolean, will be set to ``True`` if string was converted successfully + - ok: boolean, ``True`` if string was converted successfully .. seealso:: :py:func:`encodeUnit` %End diff --git a/python/PyQt6/core/auto_generated/qgsvectorfilewriter.sip.in b/python/PyQt6/core/auto_generated/qgsvectorfilewriter.sip.in index d5a75ba87544..c7f966c4ad4b 100644 --- a/python/PyQt6/core/auto_generated/qgsvectorfilewriter.sip.in +++ b/python/PyQt6/core/auto_generated/qgsvectorfilewriter.sip.in @@ -255,7 +255,6 @@ Write contents of vector layer to an (OGR supported) vector format :param destCRS: CRS to reproject exported geometries to, or invalid CRS for no reprojection :param driverName: OGR driver to use :param onlySelected: write only selected features of layer -:param errorMessage: will be set to the error message text, if an error occurs while writing the layer :param datasourceOptions: list of OGR data source creation options :param layerOptions: list of OGR layer creation options :param skipAttributeCreation: only write geometries @@ -270,6 +269,8 @@ Write contents of vector layer to an (OGR supported) vector format :param attributes: attributes to export (empty means all unless skipAttributeCreation is set) :param fieldValueConverter: field value converter (added in QGIS 2.16) +:return: - errorMessage: the error message text, if an error occurs while writing the layer + .. deprecated:: 3.40 Use :py:func:`~QgsVectorFileWriter.writeAsVectorFormatV2` instead. @@ -306,7 +307,6 @@ Writes a layer out to a vector file. for no transformation :param driverName: OGR driver to use :param onlySelected: write only selected features of layer -:param errorMessage: will be set to the error message text, if an error occurs while writing the layer :param datasourceOptions: list of OGR data source creation options :param layerOptions: list of OGR layer creation options :param skipAttributeCreation: only write geometries @@ -321,6 +321,8 @@ Writes a layer out to a vector file. :param attributes: attributes to export (empty means all unless skipAttributeCreation is set) :param fieldValueConverter: field value converter (added in QGIS 2.16) +:return: - errorMessage: the error message text, if an error occurs while writing the layer + .. deprecated:: 3.40 Use :py:func:`~QgsVectorFileWriter.writeAsVectorFormatV2` instead. @@ -406,7 +408,8 @@ Writes a layer out to a vector file. :param fileName: file name to write to :param options: options. :param newFilename: QString pointer which will contain the new file name created (in case it is different to fileName). -:param errorMessage: will be set to the error message text, if an error occurs while writing the layer + +:return: - errorMessage: the error message text, if an error occurs while writing the layer .. deprecated:: 3.40 @@ -478,7 +481,7 @@ Writes a layer out to a vector file. :param newLayer: potentially modified layer name (output parameter) :return: - Error message code, or QgsVectorFileWriter.NoError if the write operation was successful - - errorMessage: will be set to the error message text, if an error occurs while writing the layer + - errorMessage: the error message text, if an error occurs while writing the layer .. deprecated:: 3.20 @@ -499,11 +502,11 @@ Writes a layer out to a vector file. :param fileName: file name to write to :param transformContext: coordinate transform context :param options: save options -:param newFilename: potentially modified file name (output parameter) -:param errorMessage: will be set to the error message text, if an error occurs while writing the layer :return: - Error message code, or QgsVectorFileWriter.NoError if the write operation was successful + - newFilename: potentially modified file name (output parameter) - newLayer: potentially modified layer name (output parameter) + - errorMessage: the error message text, if an error occurs while writing the layer .. versionadded:: 3.20 %End diff --git a/python/PyQt6/core/auto_generated/raster/qgsrasterattributetable.sip.in b/python/PyQt6/core/auto_generated/raster/qgsrasterattributetable.sip.in index 0338b7994d5e..71222e9d56eb 100644 --- a/python/PyQt6/core/auto_generated/raster/qgsrasterattributetable.sip.in +++ b/python/PyQt6/core/auto_generated/raster/qgsrasterattributetable.sip.in @@ -359,7 +359,7 @@ Returns a field by name or a default constructed field with empty name if the fi :param name: of the field :return: - the matching field or a default constructed one. - - ok: will be set to ``True`` if the field was found. + - ok: ``True`` if the field was found. %End const QList fieldsByUsage( const Qgis::RasterAttributeTableFieldUsage fieldUsage ) const; diff --git a/python/PyQt6/core/auto_generated/raster/qgsrasterlayerutils.sip.in b/python/PyQt6/core/auto_generated/raster/qgsrasterlayerutils.sip.in index 03a791ed11dd..9326b9ebf6b6 100644 --- a/python/PyQt6/core/auto_generated/raster/qgsrasterlayerutils.sip.in +++ b/python/PyQt6/core/auto_generated/raster/qgsrasterlayerutils.sip.in @@ -38,7 +38,7 @@ respecting any elevation and temporal settings which affect the rendered band. :param elevationRange: elevation range for rendering :return: - Matched band, or -1 if the layer does not have any elevation or temporal settings which affect the rendered band. - - matched: will be set to ``True`` if a band matching the temporal and elevation range was found + - matched: ``True`` if a band matching the temporal and elevation range was found %End }; diff --git a/python/PyQt6/core/auto_generated/raster/qgsrastershader.sip.in b/python/PyQt6/core/auto_generated/raster/qgsrastershader.sip.in index f901f15d17f6..5ae6c0719f3e 100644 --- a/python/PyQt6/core/auto_generated/raster/qgsrastershader.sip.in +++ b/python/PyQt6/core/auto_generated/raster/qgsrastershader.sip.in @@ -55,11 +55,11 @@ Returns the minimum value for the raster shader. Generates a new RGBA value based on one input ``value``. :param value: The original value to base a new RGBA value on -:param returnRedValue: The red component of the new RGBA value -:param returnGreenValue: The green component of the new RGBA value -:param returnBlueValue: The blue component of the new RGBA value :return: - ``True`` if the return values are valid otherwise ``False`` + - returnRedValue: The red component of the new RGBA value + - returnGreenValue: The green component of the new RGBA value + - returnBlueValue: The blue component of the new RGBA value - returnAlpha: The alpha component of the new RGBA value %End @@ -78,11 +78,11 @@ Generates a new RGBA value based on an original RGBA value. :param greenValue: The green component of the original value to base a new RGBA value on :param blueValue: The blue component of the original value to base a new RGBA value on :param alphaValue: The alpha component of the original value to base a new RGBA value on -:param returnRedValue: The red component of the new RGBA value -:param returnGreenValue: The green component of the new RGBA value -:param returnBlueValue: The blue component of the new RGBA value :return: - ``True`` if the return values are valid otherwise ``False`` + - returnRedValue: The red component of the new RGBA value + - returnGreenValue: The green component of the new RGBA value + - returnBlueValue: The blue component of the new RGBA value - returnAlpha: The alpha component of the new RGBA value %End diff --git a/python/PyQt6/core/auto_generated/raster/qgsrastershaderfunction.sip.in b/python/PyQt6/core/auto_generated/raster/qgsrastershaderfunction.sip.in index ee6a5402ed75..f06535e80132 100644 --- a/python/PyQt6/core/auto_generated/raster/qgsrastershaderfunction.sip.in +++ b/python/PyQt6/core/auto_generated/raster/qgsrastershaderfunction.sip.in @@ -59,11 +59,11 @@ Sets the minimum ``value`` for the raster shader. Generates an new RGBA value based on one input ``value``. :param value: The original value to base a new RGBA value on -:param returnRedValue: The red component of the new RGBA value -:param returnGreenValue: The green component of the new RGBA value -:param returnBlueValue: The blue component of the new RGBA value :return: - ``True`` if the return values are valid otherwise ``False`` + - returnRedValue: The red component of the new RGBA value + - returnGreenValue: The green component of the new RGBA value + - returnBlueValue: The blue component of the new RGBA value - returnAlpha: The alpha component of the new RGBA value %End @@ -82,11 +82,11 @@ Generates an new RGBA value based on an original RGBA value. :param greenValue: The green component of the original value to base a new RGBA value on :param blueValue: The blue component of the original value to base a new RGBA value on :param alphaValue: The alpha component of the original value to base a new RGBA value on -:param returnRedValue: The red component of the new RGBA value -:param returnGreenValue: The green component of the new RGBA value -:param returnBlueValue: The blue component of the new RGBA value :return: - ``True`` if the return values are valid otherwise ``False`` + - returnRedValue: The red component of the new RGBA value + - returnGreenValue: The green component of the new RGBA value + - returnBlueValue: The blue component of the new RGBA value - returnAlpha: The alpha component of the new RGBA value %End diff --git a/python/PyQt6/core/auto_generated/symbology/qgsrenderer.sip.in b/python/PyQt6/core/auto_generated/symbology/qgsrenderer.sip.in index b68167213a56..a67a53c2b0af 100644 --- a/python/PyQt6/core/auto_generated/symbology/qgsrenderer.sip.in +++ b/python/PyQt6/core/auto_generated/symbology/qgsrenderer.sip.in @@ -361,7 +361,7 @@ the features displayed using that key. :param layer: associated vector layer :return: - QGIS expression string for matching features with the specified key - - ok: will be set to ``True`` if legend key was successfully converted to a filter expression + - ok: ``True`` if legend key was successfully converted to a filter expression .. seealso:: :py:func:`legendKeys` diff --git a/python/PyQt6/core/auto_generated/symbology/qgssymbollayerutils.sip.in b/python/PyQt6/core/auto_generated/symbology/qgssymbollayerutils.sip.in index e462c4940412..32831d6fc25a 100644 --- a/python/PyQt6/core/auto_generated/symbology/qgssymbollayerutils.sip.in +++ b/python/PyQt6/core/auto_generated/symbology/qgssymbollayerutils.sip.in @@ -67,7 +67,7 @@ Decodes a ``string`` representing a symbol coordinate reference mode. :param string: string to decode :return: - decoded marker clip mode - - ok: will be set to ``True`` if ``string`` was successfully decoded + - ok: ``True`` if ``string`` was successfully decoded .. seealso:: :py:func:`encodeCoordinateReference` @@ -106,7 +106,7 @@ Decodes a ``string`` representing a marker clip mode. :param string: string to decode :return: - decoded marker clip mode - - ok: will be set to ``True`` if ``string`` was successfully decoded + - ok: ``True`` if ``string`` was successfully decoded .. seealso:: :py:func:`encodeMarkerClipMode` @@ -129,7 +129,7 @@ Decodes a ``string`` representing a line clip mode. :param string: string to decode :return: - decoded line clip mode - - ok: will be set to ``True`` if ``string`` was successfully decoded + - ok: ``True`` if ``string`` was successfully decoded .. seealso:: :py:func:`encodeLineClipMode` @@ -170,7 +170,7 @@ Converts a ``value`` to a point. :param value: value to convert :return: - converted point - - ok: will be set to ``True`` if value was successfully converted + - ok: ``True`` if value was successfully converted .. seealso:: :py:func:`decodePoint` @@ -204,7 +204,7 @@ Converts a ``value`` to a size. :param value: value to convert :return: - converted size - - ok: will be set to ``True`` if value was successfully converted + - ok: ``True`` if value was successfully converted .. seealso:: :py:func:`decodeSize` @@ -662,7 +662,7 @@ Attempts to parse mime data as a color :param data: mime data to parse :return: - valid color if mimedata could be interpreted as a color, otherwise an invalid color - - hasAlpha: will be set to ``True`` if mime data was interpreted as a color containing an explicit alpha value + - hasAlpha: ``True`` if mime data was interpreted as a color containing an explicit alpha value %End static QgsNamedColorList colorListFromMimeData( const QMimeData *data ); diff --git a/python/PyQt6/core/auto_generated/textrenderer/qgsfontmanager.sip.in b/python/PyQt6/core/auto_generated/textrenderer/qgsfontmanager.sip.in index 5435541f16be..25eb17204c48 100644 --- a/python/PyQt6/core/auto_generated/textrenderer/qgsfontmanager.sip.in +++ b/python/PyQt6/core/auto_generated/textrenderer/qgsfontmanager.sip.in @@ -197,7 +197,7 @@ font is installed and available for use. :param family: input font family name to try to match to known fonts :return: - ``True`` if match was successful and the download will occur - - matchedFamily: will be set to found font family if a match was successful + - matchedFamily: found font family if a match was successful %End void enableFontDownloadsForSession(); @@ -219,7 +219,7 @@ return an empty string for any font families not present in this list. :param family: input font family name to try to match to known fonts :return: - URL to download font, or an empty string if no URL is available - - matchedFamily: will be set to found font family if a match was successful + - matchedFamily: found font family if a match was successful .. deprecated:: 3.38 @@ -239,7 +239,7 @@ return an invalid :py:class:`QgsFontDownloadDetails` for any font families not p :param family: input font family name to try to match to known fonts :return: - details required for downloading font, or an invalid :py:class:`QgsFontDownloadDetails` if no URL is available - - matchedFamily: will be set to found font family if a match was successful + - matchedFamily: found font family if a match was successful .. versionadded:: 3.38 %End @@ -292,7 +292,7 @@ or a zipped archive of font files. :param extension: known file extension (eg "ttf", "otf") for font. Should be specified to avoid issues with font installation on Windows if filename is not specified (since QGIS 3.38) :return: - ``True`` if installation was successful. - - errorMessage: will be set to a descriptive error message if the installation fails + - errorMessage: a descriptive error message if the installation fails - families: will be populated with a list of font families installed from the data - licenseDetails: will be populated with font license details, if found %End diff --git a/python/PyQt6/core/auto_generated/vector/qgsvectorlayer.sip.in b/python/PyQt6/core/auto_generated/vector/qgsvectorlayer.sip.in index 58c97242a388..1020c8d234aa 100644 --- a/python/PyQt6/core/auto_generated/vector/qgsvectorlayer.sip.in +++ b/python/PyQt6/core/auto_generated/vector/qgsvectorlayer.sip.in @@ -2413,8 +2413,8 @@ and maximum values are required. .. seealso:: :py:func:`maximumValue` -:return: - minimum: will be set to minimum attribute value or an invalid variant in case of error. - - maximum: will be set to maximum attribute value or an invalid variant in case of error. +:return: - minimum: minimum attribute value or an invalid variant in case of error. + - maximum: maximum attribute value or an invalid variant in case of error. .. versionadded:: 3.20 %End diff --git a/python/PyQt6/core/auto_generated/vector/qgsvectorlayereditbuffergroup.sip.in b/python/PyQt6/core/auto_generated/vector/qgsvectorlayereditbuffergroup.sip.in index 213796a3e16f..576f78339917 100644 --- a/python/PyQt6/core/auto_generated/vector/qgsvectorlayereditbuffergroup.sip.in +++ b/python/PyQt6/core/auto_generated/vector/qgsvectorlayereditbuffergroup.sip.in @@ -83,7 +83,7 @@ that the user has some chance of repairing the damage cleanly. Otherwise the layer editing mode will be disabled if the commit is successful. :return: - ``True`` on success - - commitErrors: will be set to a list of descriptive errors if the commit fails. + - commitErrors: a list of descriptive errors if the commit fails. %End bool rollBack( QStringList &rollbackErrors /Out/, bool stopEditing = true ); @@ -94,7 +94,7 @@ Stop editing and discard the edits Otherwise the layer editing mode will be disabled if the rollback is successful. :return: - ``False`` if errors occurred during rollback - - rollbackErrors: will be set to a list of descriptive errors if the rollback fails. + - rollbackErrors: a list of descriptive errors if the rollback fails. %End bool isEditing() const; diff --git a/python/PyQt6/core/auto_generated/vector/qgsvectorlayereditutils.sip.in b/python/PyQt6/core/auto_generated/vector/qgsvectorlayereditutils.sip.in index ed5a080f47d0..e813ba05168a 100644 --- a/python/PyQt6/core/auto_generated/vector/qgsvectorlayereditutils.sip.in +++ b/python/PyQt6/core/auto_generated/vector/qgsvectorlayereditutils.sip.in @@ -327,7 +327,7 @@ Merge features into a single one. :param unionGeometry: is the resulting geometry of the merged feature :return: - ``True`` if the merge was successful, or ``False`` if the operation failed. - - errorMessage: will be set to a descriptive error message if any occurs + - errorMessage: a descriptive error message if any occurs .. versionadded:: 3.30 %End diff --git a/python/PyQt6/core/auto_generated/vector/qgsvectorlayerexporter.sip.in b/python/PyQt6/core/auto_generated/vector/qgsvectorlayerexporter.sip.in index 4fd4e3fe29c8..2f2e60d426b2 100644 --- a/python/PyQt6/core/auto_generated/vector/qgsvectorlayerexporter.sip.in +++ b/python/PyQt6/core/auto_generated/vector/qgsvectorlayerexporter.sip.in @@ -46,11 +46,11 @@ Writes the contents of vector layer to a different datasource. :param destCRS: destination CRS, or an invalid (default constructed) CRS if not available :param onlySelected: set to ``True`` to export only selected features -:param errorMessage: if non-null, will be set to any error messages :param options: optional provider dataset options :param feedback: optional feedback object to show progress and cancellation of export -:return: NoError for a successful export, or encountered error +:return: - NoError for a successful export, or encountered error + - errorMessage: if non-null, any error messages %End QgsVectorLayerExporter( const QString &uri, diff --git a/python/PyQt6/core/auto_generated/vectortile/qgsmapboxglstyleconverter.sip.in b/python/PyQt6/core/auto_generated/vectortile/qgsmapboxglstyleconverter.sip.in index 240fce717a7b..20213b22da9d 100644 --- a/python/PyQt6/core/auto_generated/vectortile/qgsmapboxglstyleconverter.sip.in +++ b/python/PyQt6/core/auto_generated/vectortile/qgsmapboxglstyleconverter.sip.in @@ -547,7 +547,7 @@ Parses a color value which is interpolated by zoom range. :param context: conversion context :return: - :py:class:`QgsProperty` representing interpolation settings - - defaultColor: storage for a reasonable "default" color representing the overall property. + - defaultColor: a reasonable "default" color representing the overall property. %End static QgsProperty parseInterpolateByZoom( const QVariantMap &json, QgsMapBoxGlStyleConversionContext &context, double multiplier = 1, double *defaultNumber /Out/ = 0 ); @@ -559,7 +559,7 @@ Parses a numeric value which is interpolated by zoom range. :param multiplier: optional multiplication factor :return: - :py:class:`QgsProperty` representing interpolation settings - - defaultNumber: storage for a reasonable "default" number representing the overall property. + - defaultNumber: a reasonable "default" number representing the overall property. %End static QgsProperty parseInterpolateOpacityByZoom( const QVariantMap &json, int maxOpacity, QgsMapBoxGlStyleConversionContext *contextPtr = 0 ); diff --git a/python/PyQt6/gui/auto_generated/history/qgshistoryproviderregistry.sip.in b/python/PyQt6/gui/auto_generated/history/qgshistoryproviderregistry.sip.in index df9a93ce0354..68c3a5e725f6 100644 --- a/python/PyQt6/gui/auto_generated/history/qgshistoryproviderregistry.sip.in +++ b/python/PyQt6/gui/auto_generated/history/qgshistoryproviderregistry.sip.in @@ -100,7 +100,7 @@ Entry options are specified via the ``options`` argument. :param options: options :return: - ID of newly added entry. - - ok: will be set to ``True`` if entry was successfully added + - ok: ``True`` if entry was successfully added %End long long addEntry( const QgsHistoryEntry &entry, bool &ok /Out/, QgsHistoryProviderRegistry::HistoryEntryOptions options = QgsHistoryProviderRegistry::HistoryEntryOptions() ); @@ -111,7 +111,7 @@ Adds an ``entry`` to the history logs. :param options: options :return: - ID of newly added entry. - - ok: will be set to ``True`` if entry was successfully added + - ok: ``True`` if entry was successfully added .. seealso:: :py:func:`entryAdded` %End diff --git a/python/PyQt6/gui/auto_generated/qgsattributeform.sip.in b/python/PyQt6/gui/auto_generated/qgsattributeform.sip.in index 5ed0ff9c84d8..ae43408a18de 100644 --- a/python/PyQt6/gui/auto_generated/qgsattributeform.sip.in +++ b/python/PyQt6/gui/auto_generated/qgsattributeform.sip.in @@ -286,7 +286,7 @@ Save all the values from the editors to the layer. :return: - ``True`` if save was successful - - error: will be set to an explanatory error message if an error occurs while saving the form. + - error: an explanatory error message if an error occurs while saving the form. .. versionadded:: 3.18 %End diff --git a/python/PyQt6/gui/auto_generated/qgsexpressionlineedit.sip.in b/python/PyQt6/gui/auto_generated/qgsexpressionlineedit.sip.in index e139aa32da72..c3e1926ff2d7 100644 --- a/python/PyQt6/gui/auto_generated/qgsexpressionlineedit.sip.in +++ b/python/PyQt6/gui/auto_generated/qgsexpressionlineedit.sip.in @@ -113,7 +113,7 @@ Determines if the current expression is valid. :return: - ``True`` if the current expression is valid. - - expressionError: will be set to any generated error message + - expressionError: any generated error message %End void registerExpressionContextGenerator( const QgsExpressionContextGenerator *generator ); diff --git a/python/PyQt6/gui/auto_generated/qgsnewvectorlayerdialog.sip.in b/python/PyQt6/gui/auto_generated/qgsnewvectorlayerdialog.sip.in index 39eecf139c8c..acee3ed30c19 100644 --- a/python/PyQt6/gui/auto_generated/qgsnewvectorlayerdialog.sip.in +++ b/python/PyQt6/gui/auto_generated/qgsnewvectorlayerdialog.sip.in @@ -48,8 +48,8 @@ If ``encoding`` is specified, it will be set to the encoding of the created file :param crs: default layer CRS to show in dialog :return: - Newly created file name, or an empty string if user canceled or an error occurred. - - errorMessage: will be set to any error message encountered during layer creation - - encoding: will be set to file encoding of created layer + - errorMessage: any error message encountered during layer creation + - encoding: file encoding of created layer .. versionadded:: 3.4.5 %End diff --git a/python/analysis/auto_generated/georeferencing/qgsgcpgeometrytransformer.sip.in b/python/analysis/auto_generated/georeferencing/qgsgcpgeometrytransformer.sip.in index d6acb7d3e551..532ab0bd6db3 100644 --- a/python/analysis/auto_generated/georeferencing/qgsgcpgeometrytransformer.sip.in +++ b/python/analysis/auto_generated/georeferencing/qgsgcpgeometrytransformer.sip.in @@ -52,7 +52,7 @@ Transforms the specified input ``geometry`` using the GCP based transform. If this is done, the geometry will be left in a semi-transformed state. :return: - transformed geometry - - ok: will be set to ``True`` if geometry was successfully transformed, or ``False`` if an error occurred + - ok: ``True`` if geometry was successfully transformed, or ``False`` if an error occurred %End QgsGcpTransformerInterface *gcpTransformer() const; diff --git a/python/core/auto_generated/classification/qgsclassificationmethod.sip.in b/python/core/auto_generated/classification/qgsclassificationmethod.sip.in index 6016fe8b8ca5..def363122f36 100644 --- a/python/core/auto_generated/classification/qgsclassificationmethod.sip.in +++ b/python/core/auto_generated/classification/qgsclassificationmethod.sip.in @@ -262,7 +262,7 @@ This will calculate the classes for a given layer to define the classes. :param nclasses: The number of classes to be returned :return: - list of generated classes - - error: will be set to error string if an error occurred while generating the classes + - error: error string if an error occurred while generating the classes .. versionadded:: 3.38 %End diff --git a/python/core/auto_generated/expression/qgsexpression.sip.in b/python/core/auto_generated/expression/qgsexpression.sip.in index d6bff3e67ddf..9cb87d361e56 100644 --- a/python/core/auto_generated/expression/qgsexpression.sip.in +++ b/python/core/auto_generated/expression/qgsexpression.sip.in @@ -696,8 +696,8 @@ Returns ``True`` if the given ``expression`` is a simple "field=value" type expr :param expression: expression to test :return: - ``True`` if the expression is a field equality expression - - field: will be set to the field name if the expression is a field equality expression - - value: will be set to the value if the expression is a field equality expression + - field: the field name if the expression is a field equality expression + - value: the value if the expression is a field equality expression .. versionadded:: 3.18 %End @@ -714,7 +714,7 @@ Returns ``True`` if the given ``expressions`` could be converted to an IN type e :param expressions: expressions to test :return: - ``True`` if the expression was converted to a field IN type expression - - result: will be set to the calculated "field IN (...)" expression, wherever possible + - result: the calculated "field IN (...)" expression, wherever possible .. versionadded:: 3.18 %End diff --git a/python/core/auto_generated/geometry/qgsabstractgeometry.sip.in b/python/core/auto_generated/geometry/qgsabstractgeometry.sip.in index b4d656aebca8..19d67011cc7d 100644 --- a/python/core/auto_generated/geometry/qgsabstractgeometry.sip.in +++ b/python/core/auto_generated/geometry/qgsabstractgeometry.sip.in @@ -437,11 +437,11 @@ Returns the point corresponding to a specified vertex id Searches for the closest segment of the geometry to a given point. :param pt: specifies the point to find closest segment to -:param segmentPt: storage for the closest point within the geometry -:param vertexAfter: storage for the ID of the vertex at the end of the closest segment :param epsilon: epsilon for segment snapping :return: - squared distance to closest segment or negative value on error + - segmentPt: the closest point within the geometry + - vertexAfter: the ID of the vertex at the end of the closest segment - leftOf: indicates whether the point lies on the left side of the geometry (-1 if point is to the left of the geometry, +1 if the point is to the right of the geometry, or 0 for cases where left/right could not be determined, e.g. point exactly on a line) ``False`` if point is to right of segment) %End @@ -784,7 +784,7 @@ Checks validity of the geometry, and returns ``True`` if the geometry is valid. (corresponding to :py:class:`Qgis`.GeometryValidityFlags). :return: - ``True`` if geometry is valid - - error: will be set to the validity error message + - error: the validity error message .. versionadded:: 3.8 %End diff --git a/python/core/auto_generated/geometry/qgscurve.sip.in b/python/core/auto_generated/geometry/qgscurve.sip.in index 79cdce98b3c2..91f30908d99a 100644 --- a/python/core/auto_generated/geometry/qgscurve.sip.in +++ b/python/core/auto_generated/geometry/qgscurve.sip.in @@ -144,8 +144,8 @@ Returns the point and vertex id of a point within the curve. :param node: node number, where the first node is 0 :return: - ``True`` if node exists within the curve - - point: will be set to point at corresponding node in the curve - - type: will be set to the vertex type of the node + - point: point at corresponding node in the curve + - type: the vertex type of the node %End virtual int indexOf( const QgsPoint &point ) const = 0; diff --git a/python/core/auto_generated/geometry/qgsgeometry.sip.in b/python/core/auto_generated/geometry/qgsgeometry.sip.in index 7e6d3a3056dd..449e6c591bbb 100644 --- a/python/core/auto_generated/geometry/qgsgeometry.sip.in +++ b/python/core/auto_generated/geometry/qgsgeometry.sip.in @@ -650,10 +650,10 @@ and the indices of the vertices before and after the closest vertex. :param point: point to search for :return: - closest point in geometry. If not found (empty geometry), returns null point and sqrDist is negative. - - closestVertexIndex: will be set to the vertex index of the closest found vertex - - previousVertexIndex: will be set to the vertex index of the previous vertex from the closest one. Will be set to -1 if not present. - - nextVertexIndex: will be set to the vertex index of the next vertex after the closest one. Will be set to -1 if not present. - - sqrDist: will be set to the square distance between the closest vertex and the specified point + - closestVertexIndex: the vertex index of the closest found vertex + - previousVertexIndex: the vertex index of the previous vertex from the closest one. Will be set to -1 if not present. + - nextVertexIndex: the vertex index of the next vertex after the closest one. Will be set to -1 if not present. + - sqrDist: the square distance between the closest vertex and the specified point %End double distanceToVertex( int vertex ) const; diff --git a/python/core/auto_generated/geometry/qgsgeometryengine.sip.in b/python/core/auto_generated/geometry/qgsgeometryengine.sip.in index ab596c694595..53b548994c26 100644 --- a/python/core/auto_generated/geometry/qgsgeometryengine.sip.in +++ b/python/core/auto_generated/geometry/qgsgeometryengine.sip.in @@ -272,14 +272,14 @@ Determines whether the geometry is simple (according to OGC definition). Splits this geometry according to a given line. :param splitLine: the line that splits the geometry -:param newGeometries: list of new geometries that have been created with the split :param topological: ``True`` if topological editing is enabled :param topologyTestPoints: points that need to be tested for topological completeness in the dataset :param errorMsg: error messages emitted, if any :param skipIntersectionCheck: set to ``True`` to skip the potentially expensive initial intersection check. Only set this flag if an intersection test has already been performed by the caller! -:return: 0 in case of success, 1 if geometry has not been split, error else +:return: - 0 in case of success, 1 if geometry has not been split, error else + - newGeometries: list of new geometries that have been created with the split %End virtual QgsAbstractGeometry *offsetCurve( double distance, int segments, Qgis::JoinStyle joinStyle, double miterLimit, QString *errorMsg = 0 ) const = 0 /Factory/; diff --git a/python/core/auto_generated/geometry/qgsgeometryutils.sip.in b/python/core/auto_generated/geometry/qgsgeometryutils.sip.in index 9a35a8341d6d..8db55ed5e830 100644 --- a/python/core/auto_generated/geometry/qgsgeometryutils.sip.in +++ b/python/core/auto_generated/geometry/qgsgeometryutils.sip.in @@ -61,10 +61,10 @@ Retrieves the vertices which are before and after the interpolated point at a sp :param geometry: line or polygon geometry :param distance: distance to traverse along geometry -:param previousVertex: will be set to previous vertex ID :return: - ``True`` if vertices were successfully retrieved - - nextVertex: will be set to next vertex ID + - previousVertex: previous vertex ID + - nextVertex: next vertex ID .. note:: @@ -808,12 +808,13 @@ The result is a line (segment) centered in point p and perpendicular to segment :param segmentPoint1y: : y-coordinate of segmentPoint1, the segment's start point :param segmentPoint2x: : x-coordinate of segmentPoint2, the segment's end point :param segmentPoint2y: : y-coordinate of segmentPoint2, the segment's end point -:param perpendicularSegmentPoint1x: : x-coordinate of the perpendicularCenterSegment's start point -:param perpendicularSegmentPoint1y: : y-coordinate of the perpendicularCenterSegment's start point -:param perpendicularSegmentPoint2x: : x-coordinate of the perpendicularCenterSegment's end point -:param perpendicularSegmentPoint2y: : y-coordinate of the perpendicularCenterSegment's end point :param segmentLength: (optional) Trims to given length. A segmentLength value of 0 refers to the default length which is double the length of the input segment. Set to 1 for a normalized length. +:return: - perpendicularSegmentPoint1x: : x-coordinate of the perpendicularCenterSegment's start point + - perpendicularSegmentPoint1y: : y-coordinate of the perpendicularCenterSegment's start point + - perpendicularSegmentPoint2x: : x-coordinate of the perpendicularCenterSegment's end point + - perpendicularSegmentPoint2y: : y-coordinate of the perpendicularCenterSegment's end point + .. versionadded:: 3.24 .. deprecated:: 3.40 @@ -848,10 +849,10 @@ A method to project one skew line onto another. :param P12: is the second point that belongs to first skew line, :param P2: is the first point that belongs to second skew line, :param P22: is the second point that belongs to second skew line, -:param X1: is the result projection point of line P2P22 onto line P1P12, :param epsilon: the tolerance to use. -:return: ``True`` if such point exists, ``False`` - otherwise. +:return: - ``True`` if such point exists, ``False`` - otherwise. + - X1: is the result projection point of line P2P22 onto line P1P12, .. deprecated:: 3.40 diff --git a/python/core/auto_generated/geometry/qgsgeometryutils_base.sip.in b/python/core/auto_generated/geometry/qgsgeometryutils_base.sip.in index 25d7ea6fbc62..012c66b0e4f5 100644 --- a/python/core/auto_generated/geometry/qgsgeometryutils_base.sip.in +++ b/python/core/auto_generated/geometry/qgsgeometryutils_base.sip.in @@ -257,12 +257,13 @@ The result is a line (segment) centered in point p and perpendicular to segment :param segmentPoint1y: : y-coordinate of segmentPoint1, the segment's start point :param segmentPoint2x: : x-coordinate of segmentPoint2, the segment's end point :param segmentPoint2y: : y-coordinate of segmentPoint2, the segment's end point -:param perpendicularSegmentPoint1x: : x-coordinate of the perpendicularCenterSegment's start point -:param perpendicularSegmentPoint1y: : y-coordinate of the perpendicularCenterSegment's start point -:param perpendicularSegmentPoint2x: : x-coordinate of the perpendicularCenterSegment's end point -:param perpendicularSegmentPoint2y: : y-coordinate of the perpendicularCenterSegment's end point :param segmentLength: (optional) Trims to given length. A segmentLength value of 0 refers to the default length which is double the length of the input segment. Set to 1 for a normalized length. +:return: - perpendicularSegmentPoint1x: : x-coordinate of the perpendicularCenterSegment's start point + - perpendicularSegmentPoint1y: : y-coordinate of the perpendicularCenterSegment's start point + - perpendicularSegmentPoint2x: : x-coordinate of the perpendicularCenterSegment's end point + - perpendicularSegmentPoint2y: : y-coordinate of the perpendicularCenterSegment's end point + .. versionadded:: 3.24 %End @@ -290,10 +291,10 @@ A method to project one skew line onto another. :param P12: is the second point that belongs to first skew line, :param P2: is the first point that belongs to second skew line, :param P22: is the second point that belongs to second skew line, -:param X1: is the result projection point of line P2P22 onto line P1P12, :param epsilon: the tolerance to use. -:return: ``True`` if such point exists, ``False`` - otherwise. +:return: - ``True`` if such point exists, ``False`` - otherwise. + - X1: is the result projection point of line P2P22 onto line P1P12, %End static bool linesIntersection3D( const QgsVector3D &La1, const QgsVector3D &La2, diff --git a/python/core/auto_generated/gps/qgsgpsinformation.sip.in b/python/core/auto_generated/gps/qgsgpsinformation.sip.in index 6e82579f0462..ea305ac159bf 100644 --- a/python/core/auto_generated/gps/qgsgpsinformation.sip.in +++ b/python/core/auto_generated/gps/qgsgpsinformation.sip.in @@ -71,7 +71,7 @@ Returns the best fix status and corresponding constellation. :return: - best current fix status - - constellation: will be set to the constellation with best fix status + - constellation: the constellation with best fix status .. versionadded:: 3.30 %End diff --git a/python/core/auto_generated/numericformats/qgsfractionnumericformat.sip.in b/python/core/auto_generated/numericformats/qgsfractionnumericformat.sip.in index fde86d3362f6..58b5a3d8d903 100644 --- a/python/core/auto_generated/numericformats/qgsfractionnumericformat.sip.in +++ b/python/core/auto_generated/numericformats/qgsfractionnumericformat.sip.in @@ -135,9 +135,9 @@ This method is based of Richard's algorithm (1981) from "Continued Fractions wit :param tolerance: acceptable tolerance. Larger values will give "nicer" fractions. :return: - ``True`` if ``value`` was successfully converted to a fraction - - numerator: will be set to calculated fraction numerator - - denominator: will be set to the calculated fraction denominator - - sign: will be set to the sign of the result (as -1 or +1 values) + - numerator: calculated fraction numerator + - denominator: the calculated fraction denominator + - sign: the sign of the result (as -1 or +1 values) %End static QString toUnicodeSuperscript( const QString &input ); diff --git a/python/core/auto_generated/painting/qgspainting.sip.in b/python/core/auto_generated/painting/qgspainting.sip.in index 03d1b16c2d39..466a1d9412ca 100644 --- a/python/core/auto_generated/painting/qgspainting.sip.in +++ b/python/core/auto_generated/painting/qgspainting.sip.in @@ -60,7 +60,7 @@ to the triangle defined by (``outX1``, ``outY1``), (``outY2``, ``outY2``), (``ou :param outY3: destination triangle vertex 3 y-coordinate :return: - Calculated transform (if possible) - - ok: will be set to ``True`` if the transform could be determined. + - ok: ``True`` if the transform could be determined. .. versionadded:: 3.34 %End diff --git a/python/core/auto_generated/processing/models/qgsprocessingmodelalgorithm.sip.in b/python/core/auto_generated/processing/models/qgsprocessingmodelalgorithm.sip.in index 0c6e269be00d..bdaa3285fffa 100644 --- a/python/core/auto_generated/processing/models/qgsprocessingmodelalgorithm.sip.in +++ b/python/core/auto_generated/processing/models/qgsprocessingmodelalgorithm.sip.in @@ -78,7 +78,7 @@ Validates the model, returning ``True`` if all child algorithms in the model are :return: - ``True`` if the child is valid - - issues: will be set to a list of issues encountered during the validation + - issues: a list of issues encountered during the validation .. versionadded:: 3.14 %End @@ -211,7 +211,7 @@ all mandatory inputs to the algorithm have valid values. :param childId: ID for child to validate :return: - ``True`` if the child is valid - - issues: will be set to a list of issues encountered during the validation + - issues: a list of issues encountered during the validation .. versionadded:: 3.14 %End diff --git a/python/core/auto_generated/processing/qgsprocessingalgorithm.sip.in b/python/core/auto_generated/processing/qgsprocessingalgorithm.sip.in index 037f507187f1..d03819a77452 100644 --- a/python/core/auto_generated/processing/qgsprocessingalgorithm.sip.in +++ b/python/core/auto_generated/processing/qgsprocessingalgorithm.sip.in @@ -442,7 +442,7 @@ Note that some combinations of parameter types and values cannot be represented :param context: processing context :return: - equivalent qgis_process command - - ok: will be set to ``True`` if the command was successfully generated + - ok: ``True`` if the command was successfully generated .. versionadded:: 3.24 %End @@ -777,7 +777,7 @@ a conversion in this case and will return the target layer name in the ``layerNa :param feedback: feedback object :return: - path to source layer, or nearly converted compatible layer - - layerName: will be set to the target layer name for multi-layer sources (e.g. Geopackage) + - layerName: the target layer name for multi-layer sources (e.g. Geopackage) .. seealso:: :py:func:`parameterAsCompatibleSourceLayerPath` diff --git a/python/core/auto_generated/processing/qgsprocessingoutputs.sip.in b/python/core/auto_generated/processing/qgsprocessingoutputs.sip.in index 57b147a3b226..bc5de415cdc2 100644 --- a/python/core/auto_generated/processing/qgsprocessingoutputs.sip.in +++ b/python/core/auto_generated/processing/qgsprocessingoutputs.sip.in @@ -131,7 +131,7 @@ Returns a string version of the parameter output ``value`` (if possible). :param context: processing context :return: - value converted to string - - ok: will be set to ``True`` if value could be represented as a string. + - ok: ``True`` if value could be represented as a string. .. seealso:: :py:func:`valueAsFormattedString` @@ -148,7 +148,7 @@ By default this will return the same value as :py:func:`~QgsProcessingOutputDefi :param context: processing context :return: - value converted to string - - ok: will be set to ``True`` if value could be represented as a string. + - ok: ``True`` if value could be represented as a string. .. seealso:: :py:func:`valueAsString` diff --git a/python/core/auto_generated/processing/qgsprocessingparameters.sip.in b/python/core/auto_generated/processing/qgsprocessingparameters.sip.in index a2de59ce1eb6..d2855bf7adca 100644 --- a/python/core/auto_generated/processing/qgsprocessingparameters.sip.in +++ b/python/core/auto_generated/processing/qgsprocessingparameters.sip.in @@ -534,7 +534,7 @@ Returns a string version of the parameter input ``value`` (if possible). :param context: processing context :return: - value converted to string - - ok: will be set to ``True`` if value could be represented as a string. + - ok: ``True`` if value could be represented as a string. .. seealso:: :py:func:`valueAsStringList` @@ -553,7 +553,7 @@ Returns a string list version of the parameter input ``value`` (if possible). :param context: processing context :return: - value converted to string list - - ok: will be set to ``True`` if value could be represented as a string list + - ok: ``True`` if value could be represented as a string list .. seealso:: :py:func:`valueAsString` @@ -1140,7 +1140,7 @@ a conversion in this case and will return the target layer name in the ``layerNa :param feedback: feedback object :return: - path to source layer, or nearly converted compatible layer - - layerName: will be set to the target layer name for multi-layer sources (e.g. Geopackage) + - layerName: the target layer name for multi-layer sources (e.g. Geopackage) .. seealso:: :py:func:`parameterAsCompatibleSourceLayerPath` @@ -3507,7 +3507,7 @@ calls :py:func:`QgsProcessingProvider.isSupportedOutputValue()` to test compatib :param context: Processing context :return: - ``True`` if ``value`` is supported. - - error: will be set to a descriptive error string + - error: a descriptive error string .. versionadded:: 3.14 %End diff --git a/python/core/auto_generated/processing/qgsprocessingutils.sip.in b/python/core/auto_generated/processing/qgsprocessingutils.sip.in index d55e6e2a7c22..71ca251de91c 100644 --- a/python/core/auto_generated/processing/qgsprocessingutils.sip.in +++ b/python/core/auto_generated/processing/qgsprocessingutils.sip.in @@ -504,11 +504,11 @@ a conversion in this case and will return the target layer name in the ``layerNa :param preferredFormat: preferred format extension to use if conversion if required :param context: processing context :param feedback: feedback object -:param layerName: will be set to the target layer name for multi-layer sources (e.g. Geopackage) :param featureLimit: can be used to place a limit on the maximum number of features read from the layer :param filterExpression: optional expression for filtering features read from the layer (since QGIS 3.32) -:return: path to source layer, or nearly converted compatible layer +:return: - path to source layer, or nearly converted compatible layer + - layerName: the target layer name for multi-layer sources (e.g. Geopackage) .. seealso:: :py:func:`convertToCompatibleFormat` diff --git a/python/core/auto_generated/proj/qgscoordinatereferencesystem.sip.in b/python/core/auto_generated/proj/qgscoordinatereferencesystem.sip.in index 244455d458f3..a9b4fe415669 100644 --- a/python/core/auto_generated/proj/qgscoordinatereferencesystem.sip.in +++ b/python/core/auto_generated/proj/qgscoordinatereferencesystem.sip.in @@ -323,7 +323,7 @@ or the compound CRS could not be created for the combination. :param verticalCrs: vertical component for CRS :return: - compound CRS if it was possible to create one, or an invalid CRS if not - - error: will be set to a descriptive error if the compound CRS could not be created + - error: a descriptive error if the compound CRS could not be created .. versionadded:: 3.38 %End diff --git a/python/core/auto_generated/project/qgsproject.sip.in b/python/core/auto_generated/project/qgsproject.sip.in index db21d564490b..947ba1cbaae5 100644 --- a/python/core/auto_generated/project/qgsproject.sip.in +++ b/python/core/auto_generated/project/qgsproject.sip.in @@ -426,7 +426,7 @@ The :py:func:`~QgsProject.verticalCrsChanged` signal will be raised if the verti :param crs: the vertical CRS :return: - ``True`` if vertical CRS was successfully set - - errorMessage: will be set to a descriptive message if the vertical CRS could not be set + - errorMessage: a descriptive message if the vertical CRS could not be set .. seealso:: :py:func:`verticalCrs` @@ -2246,7 +2246,7 @@ that the user has some chance of repairing the damage cleanly. parameter is not mandatory, as the changes from all layers will be committed. :return: - ``True`` if the commit was successful. - - commitErrors: will be set to a list of descriptive errors if the commit fails. + - commitErrors: a list of descriptive errors if the commit fails. .. seealso:: :py:func:`startEditing` @@ -2265,7 +2265,7 @@ Stops a current editing operation on vectorLayer and discards any uncommitted ed parameter is not mandatory, as the changes from all layers will be rolled back. :return: - ``True`` if the rollback was successful. - - rollbackErrors: will be set to a list of descriptive errors if the rollback fails. + - rollbackErrors: a list of descriptive errors if the rollback fails. .. seealso:: :py:func:`startEditing` diff --git a/python/core/auto_generated/providers/arcgis/qgsarcgisrestutils.sip.in b/python/core/auto_generated/providers/arcgis/qgsarcgisrestutils.sip.in index a6fe48a2aa59..b04c34a9932b 100644 --- a/python/core/auto_generated/providers/arcgis/qgsarcgisrestutils.sip.in +++ b/python/core/auto_generated/providers/arcgis/qgsarcgisrestutils.sip.in @@ -96,7 +96,7 @@ Caller takes ownership of the returned object. :param hasZ: set to ``True`` to if geometry includes Z values :return: - converted geometry - - crs: will be set to the parsed geometry CRS + - crs: the parsed geometry CRS %End static QgsCoordinateReferenceSystem convertSpatialReference( const QVariantMap &spatialReferenceMap ); diff --git a/python/core/auto_generated/providers/qgsprovidermetadata.sip.in b/python/core/auto_generated/providers/qgsprovidermetadata.sip.in index 8360726b4925..66c606678920 100644 --- a/python/core/auto_generated/providers/qgsprovidermetadata.sip.in +++ b/python/core/auto_generated/providers/qgsprovidermetadata.sip.in @@ -439,7 +439,7 @@ metadata :py:func:`~QgsProviderMetadata.createDatabase` method can be used to cr :param uri: destination URI for newly created database. :return: - ``True`` if the database was successfully created - - errorMessage: will be set to a descriptive error message if the database could not be successfully created. + - errorMessage: a descriptive error message if the database could not be successfully created. .. note:: @@ -606,7 +606,7 @@ Returns ``True`` if a layer style with the specified ``styleId`` exists in the p :param styleId: style ID to test for :return: - ``True`` if the layer style already exists - - errorCause: will be set to a descriptive error message, if an error occurs while checking if the style exists + - errorCause: a descriptive error message, if an error occurs while checking if the style exists .. seealso:: :py:func:`getStyleById` diff --git a/python/core/auto_generated/providers/qgsproviderregistry.sip.in b/python/core/auto_generated/providers/qgsproviderregistry.sip.in index 61459fdd9bb3..494023856738 100644 --- a/python/core/auto_generated/providers/qgsproviderregistry.sip.in +++ b/python/core/auto_generated/providers/qgsproviderregistry.sip.in @@ -250,7 +250,7 @@ Returns ``True`` if a layer style with the specified ``styleId`` exists in the p :param styleId: style ID to test for :return: - ``True`` if the layer style already exists - - errorCause: will be set to a descriptive error message, if an error occurs while checking if the style exists + - errorCause: a descriptive error message, if an error occurs while checking if the style exists .. seealso:: :py:func:`getStyleById` diff --git a/python/core/auto_generated/providers/sensorthings/qgssensorthingsutils.sip.in b/python/core/auto_generated/providers/sensorthings/qgssensorthingsutils.sip.in index 6ad7a5f23030..45b049c4c7e4 100644 --- a/python/core/auto_generated/providers/sensorthings/qgssensorthingsutils.sip.in +++ b/python/core/auto_generated/providers/sensorthings/qgssensorthingsutils.sip.in @@ -136,7 +136,7 @@ Returns the cardinality of the relationship between a base entity type and a rel :param relatedType: related entity type :return: - relationship cardinality - - valid: will be set to ``True`` if a relationship exists between the entity types, or ``False`` if no relationship exists + - valid: ``True`` if a relationship exists between the entity types, or ``False`` if no relationship exists .. versionadded:: 3.38 %End diff --git a/python/core/auto_generated/qgsbookmarkmanager.sip.in b/python/core/auto_generated/qgsbookmarkmanager.sip.in index 7d4d4b302f81..4b19616797bb 100644 --- a/python/core/auto_generated/qgsbookmarkmanager.sip.in +++ b/python/core/auto_generated/qgsbookmarkmanager.sip.in @@ -190,7 +190,7 @@ Adds a ``bookmark`` to the manager. :param bookmark: the bookmark to add :return: - The bookmark's ID (or newly generated ID, if no ID was originally set and one was automatically generated) - - ok: will be set to ``True`` if the bookmark was successfully added, or ``False`` if the bookmark could not be added (eg as a result of a duplicate bookmark ID). + - ok: ``True`` if the bookmark was successfully added, or ``False`` if the bookmark could not be added (eg as a result of a duplicate bookmark ID). .. seealso:: :py:func:`removeBookmark` diff --git a/python/core/auto_generated/qgsdistancearea.sip.in b/python/core/auto_generated/qgsdistancearea.sip.in index 3a5641f08281..aa190111c3b4 100644 --- a/python/core/auto_generated/qgsdistancearea.sip.in +++ b/python/core/auto_generated/qgsdistancearea.sip.in @@ -372,7 +372,7 @@ will also be in this same CRS. :param p2: Ending point, in :py:func:`~QgsDistanceArea.ellipsoidCrs` :return: - the latitude at which the geodesic crosses the antimeridian - - fractionAlongLine: will be set to the fraction along the geodesic line joining ``p1`` to ``p2`` at which the antimeridian crossing occurs. + - fractionAlongLine: the fraction along the geodesic line joining ``p1`` to ``p2`` at which the antimeridian crossing occurs. .. seealso:: :py:func:`splitGeometryAtAntimeridian` diff --git a/python/core/auto_generated/qgsfileutils.sip.in b/python/core/auto_generated/qgsfileutils.sip.in index a4d61aa20bf7..e8383fcec0e2 100644 --- a/python/core/auto_generated/qgsfileutils.sip.in +++ b/python/core/auto_generated/qgsfileutils.sip.in @@ -173,7 +173,7 @@ desired. :param flags: optional flags to control file operation behavior :return: - ``True`` if the dataset was successfully renamed, or ``False`` if an error occurred - - error: will be set to a descriptive error message if the rename operation fails + - error: a descriptive error message if the rename operation fails .. versionadded:: 3.22 %End diff --git a/python/core/auto_generated/qgsimagecache.sip.in b/python/core/auto_generated/qgsimagecache.sip.in index c98efcdb8892..29defb661ac7 100644 --- a/python/core/auto_generated/qgsimagecache.sip.in +++ b/python/core/auto_generated/qgsimagecache.sip.in @@ -70,7 +70,7 @@ size, and then the result cached for subsequent lookups. animations. This should be set to -1 if not required. :return: - rendered image - - fitsInCache: will be set to ``True`` if the resultant raster was of a sufficiently small size to store in the cache + - fitsInCache: ``True`` if the resultant raster was of a sufficiently small size to store in the cache %End QSize originalSize( const QString &path, bool blocking = false ) const; diff --git a/python/core/auto_generated/qgslayerdefinition.sip.in b/python/core/auto_generated/qgslayerdefinition.sip.in index 0225bb7c0498..3ca840f2451b 100644 --- a/python/core/auto_generated/qgslayerdefinition.sip.in +++ b/python/core/auto_generated/qgslayerdefinition.sip.in @@ -67,7 +67,7 @@ for control over this setting. :param selectedTreeNodes: layer tree nodes to include in the QLR file :return: - ``True`` if the export was successful - - errorMessage: will be set to any error messages generated during the export + - errorMessage: any error messages generated during the export %End static bool exportLayerDefinition( const QString &path, const QList &selectedTreeNodes, Qgis::FilePathType pathType, QString &errorMessage /Out/ ); @@ -79,7 +79,7 @@ Exports the selected layer tree nodes to a QLR file. :param pathType: specifies whether absolute or relative file paths should be used. :return: - ``True`` if the export was successful - - errorMessage: will be set to any error messages generated during the export + - errorMessage: any error messages generated during the export .. versionadded:: 3.22 %End diff --git a/python/core/auto_generated/qgsmaplayer.sip.in b/python/core/auto_generated/qgsmaplayer.sip.in index 45a06301f60d..f2eb58f76947 100644 --- a/python/core/auto_generated/qgsmaplayer.sip.in +++ b/python/core/auto_generated/qgsmaplayer.sip.in @@ -752,12 +752,12 @@ Read all custom properties from layer. Properties are stored in a map and saved %Docstring Lists all the style in db split into related to the layer and not related to -:param ids: the list in which will be stored the style db ids -:param names: the list in which will be stored the style names :return: - the number of styles related to current layer (-1 on not implemented) + - ids: the list in which will be stored the style db ids + - names: the list in which will be stored the style names - descriptions: the list in which will be stored the style descriptions - - msgError: will be set to a descriptive error message if any occurs + - msgError: a descriptive error message if any occurs .. note:: @@ -776,7 +776,7 @@ Deletes a style from the database :param styleId: the provider's layer_styles table id of the style to delete :return: - ``True`` in case of success - - msgError: will be set to a descriptive error message if any occurs + - msgError: a descriptive error message if any occurs %End virtual void saveStyleToDatabase( const QString &name, const QString &description, @@ -790,7 +790,6 @@ Saves named and sld style of the layer to the style table in the db. :param description: A description of the style :param useAsDefault: Set to ``True`` if style should be used as the default style for the layer :param uiFileContent: -:param msgError: will be set to a descriptive error message if any occurs :param categories: the style categories to be saved. .. note:: @@ -811,10 +810,12 @@ Saves named and sld style of the layer to the style table in the db. Loads a named style from file/local db/datasource db :param theURI: the URI of the style or the URI of the layer -:param resultFlag: will be set to ``True`` if a named style is correctly loaded :param loadFromLocalDb: if ``True`` forces to load from local db instead of datasource one :param categories: the style categories to be loaded. :param flags: flags controlling how the style should be loaded (since QGIS 3.38) + +:return: - status message, which may indicate success or contain an error message + - resultFlag: ``True`` if a named style is correctly loaded %End @@ -928,7 +929,7 @@ The :py:func:`~QgsMapLayer.verticalCrsChanged` signal will be raised if the vert :param crs: the vertical CRS :return: - ``True`` if vertical CRS was successfully set - - errorMessage: will be set to a descriptive message if the vertical CRS could not be set + - errorMessage: a descriptive message if the vertical CRS could not be set .. seealso:: :py:func:`verticalCrs` @@ -976,7 +977,7 @@ record in the users style table in their personal qgis.db) :return: - a QString with any status messages - - resultFlag: a reference to a flag that will be set to ``False`` if we did not manage to save the default metadata. + - resultFlag: a reference to a flag that ``False`` if we did not manage to save the default metadata. %End QString saveNamedMetadata( const QString &uri, bool &resultFlag ); @@ -1010,7 +1011,7 @@ record in the users style table in their personal qgis.db) key matches the URI. :return: - a QString with any status messages - - resultFlag: a reference to a flag that will be set to ``False`` if we did not manage to load the default metadata. + - resultFlag: a reference to a flag that ``False`` if we did not manage to load the default metadata. %End @@ -1069,7 +1070,7 @@ record in the users style table in their personal qgis.db) :return: - a QString with any status messages - - resultFlag: a reference to a flag that will be set to ``False`` if we did not manage to load the default style. + - resultFlag: a reference to a flag that ``False`` if we did not manage to load the default style. .. seealso:: :py:func:`loadNamedStyle` %End @@ -1090,7 +1091,7 @@ record in the users style table in their personal qgis.db) :param flags: flags controlling how the style should be loaded (since QGIS 3.38) :return: - a QString with any status messages - - resultFlag: a reference to a flag that will be set to ``False`` if we did not manage to load the default style. + - resultFlag: a reference to a flag that ``False`` if we did not manage to load the default style. .. seealso:: :py:func:`loadDefaultStyle` %End @@ -1103,7 +1104,7 @@ Retrieve a named style for this layer from a sqlite database. :param uri: uri for table :return: - ``True`` if style was successfully loaded - - qml: will be set to QML style content from database + - qml: QML style content from database %End virtual bool importNamedStyle( QDomDocument &doc, QString &errorMsg /Out/, @@ -1112,11 +1113,10 @@ Retrieve a named style for this layer from a sqlite database. Import the properties of this layer from a QDomDocument :param doc: source QDomDocument -:param errorMsg: this QString will be initialized on error - during the execution of readSymbology :param categories: the style categories to import -:return: ``True`` on success +:return: - ``True`` on success + - errorMsg: this QString will be initialized on error during the execution of readSymbology %End virtual void exportNamedStyle( QDomDocument &doc, QString &errorMsg /Out/, const QgsReadWriteContext &context = QgsReadWriteContext(), @@ -1125,7 +1125,6 @@ Import the properties of this layer from a QDomDocument Export the properties of this layer as named style in a QDomDocument :param doc: the target QDomDocument -:param errorMsg: this QString will be initialized on error :param context: read write context :param categories: the style categories to export during the execution of writeSymbology @@ -1164,7 +1163,7 @@ record in the users style table in their personal qgis.db) :param categories: the style categories to be saved (since QGIS 3.26) :return: - a QString with any status messages - - resultFlag: a reference to a flag that will be set to ``False`` if we did not manage to save the default style. + - resultFlag: a reference to a flag that ``False`` if we did not manage to save the default style. .. seealso:: :py:func:`loadNamedStyle` @@ -1179,7 +1178,7 @@ record in the users style table in their personal qgis.db) :return: - a QString with any status messages - - resultFlag: a reference to a flag that will be set to ``False`` if we did not manage to save the default style. + - resultFlag: a reference to a flag that ``False`` if we did not manage to save the default style. .. seealso:: :py:func:`loadNamedStyle` @@ -1202,7 +1201,7 @@ record in the users style table in their personal qgis.db) :param categories: the style categories to be saved. :return: - a QString with any status messages - - resultFlag: a reference to a flag that will be set to ``False`` if we did not manage to save the default style. + - resultFlag: a reference to a flag that ``False`` if we did not manage to save the default style. .. seealso:: :py:func:`saveDefaultStyle` %End @@ -1229,7 +1228,7 @@ Saves the properties of this layer to an SLD format file. :param exportContext: SLD export context :return: - a string with any status or error messages - - resultFlag: a reference to a flag that will be set to ``False`` if the SLD file could not be generated + - resultFlag: a reference to a flag that ``False`` if the SLD file could not be generated .. seealso:: :py:func:`loadSldStyle` diff --git a/python/core/auto_generated/qgsmaplayerfactory.sip.in b/python/core/auto_generated/qgsmaplayerfactory.sip.in index 5931ae7c6d1a..26964f5154f8 100644 --- a/python/core/auto_generated/qgsmaplayerfactory.sip.in +++ b/python/core/auto_generated/qgsmaplayerfactory.sip.in @@ -32,7 +32,7 @@ Returns the map layer type corresponding a ``string`` value. :param string: string to convert to map layer type :return: - converted map layer type - - ok: will be set to ``True`` if ``string`` was successfully converted to a map layer type + - ok: ``True`` if ``string`` was successfully converted to a map layer type .. seealso:: :py:func:`typeToString` %End diff --git a/python/core/auto_generated/qgsmultirenderchecker.sip.in b/python/core/auto_generated/qgsmultirenderchecker.sip.in index 8fd050961a60..fa8482cbe173 100644 --- a/python/core/auto_generated/qgsmultirenderchecker.sip.in +++ b/python/core/auto_generated/qgsmultirenderchecker.sip.in @@ -198,7 +198,7 @@ page in the layout. :param createReferenceImage: if ``True``, the rendered reference image will be regenerated instead of performing a comparison test with the existing image :return: - ``True`` if the rendered layout matches the expected reference image. - - report: will be set to generated test report + - report: generated test report %End }; diff --git a/python/core/auto_generated/qgsproperty.sip.in b/python/core/auto_generated/qgsproperty.sip.in index 1c084bb9ad80..e5fc88b161a3 100644 --- a/python/core/auto_generated/qgsproperty.sip.in +++ b/python/core/auto_generated/qgsproperty.sip.in @@ -253,7 +253,7 @@ a fixed value expression ('some static value'), this method will return :param context: expression context :return: - ``True`` if property is a static value - - staticValue: will be set to evaluated static value if property is effectively a static value + - staticValue: evaluated static value if property is effectively a static value .. versionadded:: 3.24 %End @@ -355,7 +355,7 @@ Calculates the current value of the property, including any transforms which are :param defaultValue: default value to return if the property is not active or cannot be calculated :return: - calculated value for property - - ok: will be set to ``True`` if conversion was successful + - ok: ``True`` if conversion was successful .. seealso:: :py:func:`valueAsString` @@ -376,7 +376,7 @@ Calculates the current value of the property and interprets it as a datetime. :param defaultDateTime: default datetime to return if the property cannot be calculated as a datetime :return: - value parsed to datetime - - ok: will be set to ``True`` if conversion was successful + - ok: ``True`` if conversion was successful .. seealso:: :py:func:`value` @@ -401,7 +401,7 @@ Calculates the current value of the property and interprets it as a string. :param defaultString: default string to return if the property cannot be calculated as a string :return: - value parsed to string - - ok: will be set to ``True`` if conversion was successful + - ok: ``True`` if conversion was successful .. seealso:: :py:func:`value` @@ -424,7 +424,7 @@ Calculates the current value of the property and interprets it as a color. :param defaultColor: default color to return if the property cannot be calculated as a color :return: - value parsed to color - - ok: will be set to ``True`` if conversion was successful + - ok: ``True`` if conversion was successful .. seealso:: :py:func:`value` @@ -447,7 +447,7 @@ Calculates the current value of the property and interprets it as a double. :param defaultValue: default double to return if the property cannot be calculated as a double :return: - value parsed to double - - ok: will be set to ``True`` if conversion was successful + - ok: ``True`` if conversion was successful .. seealso:: :py:func:`value` @@ -470,7 +470,7 @@ Calculates the current value of the property and interprets it as an integer. :param defaultValue: default integer to return if the property cannot be calculated as an integer :return: - value parsed to integer - - ok: will be set to ``True`` if conversion was successful + - ok: ``True`` if conversion was successful .. seealso:: :py:func:`value` @@ -493,7 +493,7 @@ Calculates the current value of the property and interprets it as an boolean. :param defaultValue: default boolean to return if the property cannot be calculated as an boolean :return: - value parsed to boolean - - ok: will be set to ``True`` if conversion was successful + - ok: ``True`` if conversion was successful .. seealso:: :py:func:`value` diff --git a/python/core/auto_generated/qgspropertycollection.sip.in b/python/core/auto_generated/qgspropertycollection.sip.in index b738acc12719..a5c7fc86e4c6 100644 --- a/python/core/auto_generated/qgspropertycollection.sip.in +++ b/python/core/auto_generated/qgspropertycollection.sip.in @@ -120,7 +120,7 @@ Calculates the current value of the property with the specified key and interpre :param defaultDateTime: default datetime to return if the property cannot be calculated as a datetime :return: - value parsed to datetime - - ok: will be set to ``True`` if conversion was successful + - ok: ``True`` if conversion was successful .. seealso:: :py:func:`value` @@ -147,7 +147,7 @@ Calculates the current value of the property with the specified key and interpre :param defaultString: default string to return if the property cannot be calculated as a string :return: - value parsed to string - - ok: will be set to ``True`` if conversion was successful + - ok: ``True`` if conversion was successful .. seealso:: :py:func:`value` @@ -172,7 +172,7 @@ Calculates the current value of the property with the specified key and interpre :param defaultColor: default color to return if the property cannot be calculated as a color :return: - value parsed to color - - ok: will be set to ``True`` if conversion was successful + - ok: ``True`` if conversion was successful .. seealso:: :py:func:`value` @@ -197,7 +197,7 @@ Calculates the current value of the property with the specified key and interpre :param defaultValue: default double to return if the property cannot be calculated as a double :return: - value parsed to double - - ok: will be set to ``True`` if conversion was successful + - ok: ``True`` if conversion was successful .. seealso:: :py:func:`value` @@ -222,7 +222,7 @@ Calculates the current value of the property with the specified key and interpre :param defaultValue: default integer to return if the property cannot be calculated as a integer :return: - value parsed to integer - - ok: will be set to ``True`` if conversion was successful + - ok: ``True`` if conversion was successful .. seealso:: :py:func:`value` @@ -247,7 +247,7 @@ Calculates the current value of the property with the specified key and interpre :param defaultValue: default boolean to return if the property cannot be calculated as a boolean :return: - value parsed to bool - - ok: will be set to ``True`` if conversion was successful + - ok: ``True`` if conversion was successful .. seealso:: :py:func:`value` diff --git a/python/core/auto_generated/qgspropertytransformer.sip.in b/python/core/auto_generated/qgspropertytransformer.sip.in index 5716ee3028ef..422447215154 100644 --- a/python/core/auto_generated/qgspropertytransformer.sip.in +++ b/python/core/auto_generated/qgspropertytransformer.sip.in @@ -287,8 +287,8 @@ Attempts to parse an expression into a corresponding property transformer. :param expression: expression to parse :return: - corresponding property transformer, or ``None`` if expression could not be parsed to a transformer. - - baseExpression: will be set to the component of the source expression which is used to calculate the input to the property transformer. This will be set to an empty string if a field reference is the transformer input. - - fieldName: will be set to a field name which is used to calculate the input to the property transformer. This will be set to an empty string if an expression is the transformer input. + - baseExpression: the component of the source expression which is used to calculate the input to the property transformer. This an empty string if a field reference is the transformer input. + - fieldName: a field name which is used to calculate the input to the property transformer. This an empty string if an expression is the transformer input. %End protected: @@ -350,8 +350,8 @@ Attempts to parse an expression into a corresponding :py:class:`QgsSizeScaleTran :return: - corresponding :py:class:`QgsSizeScaleTransformer`, or ``None`` if expression could not be parsed to a size scale transformer. - - baseExpression: will be set to the component of the source expression which is used to calculate the input to the property transformer. This will be set to an empty string if a field reference is the transformer input. - - fieldName: will be set to a field name which is used to calculate the input to the property transformer. This will be set to an empty string if an expression is the transformer input. + - baseExpression: the component of the source expression which is used to calculate the input to the property transformer. This will be set to an empty string if a field reference is the transformer input. + - fieldName: a field name which is used to calculate the input to the property transformer. This will be set to an empty string if an expression is the transformer input. %End double value( double input ) const; @@ -492,8 +492,8 @@ Attempts to parse an expression into a corresponding QgsSizeScaleTransformer. :param expression: expression to parse :return: - corresponding QgsSizeScaleTransformer, or ``None`` if expression could not be parsed to a size scale transformer. - - baseExpression: will be set to the component of the source expression which is used to calculate the input to the property transformer. This will be set to an empty string if a field reference is the transformer input. - - fieldName: will be set to a field name which is used to calculate the input to the property transformer. This will be set to an empty string if an expression is the transformer input. + - baseExpression: the component of the source expression which is used to calculate the input to the property transformer. This an empty string if a field reference is the transformer input. + - fieldName: a field name which is used to calculate the input to the property transformer. This an empty string if an expression is the transformer input. %End double size( double value ) const; diff --git a/python/core/auto_generated/qgstemporalutils.sip.in b/python/core/auto_generated/qgstemporalutils.sip.in index 89877a456e33..541e258f1c80 100644 --- a/python/core/auto_generated/qgstemporalutils.sip.in +++ b/python/core/auto_generated/qgstemporalutils.sip.in @@ -80,7 +80,7 @@ support. :param feedback: optional feedback object for progress reports and cancellation checks :return: - ``True`` if the export was successful. - - error: will be set to a descriptive error message if the export fails + - error: a descriptive error message if the export fails %End static QDateTime calculateFrameTime( const QDateTime &start, const long long frame, const QgsInterval &interval ); @@ -116,8 +116,8 @@ Calculates a complete list of datetimes between ``start`` and ``end``, using the :param maxValues: maximum number of values to return, or -1 to return all values :return: - calculated list of date times - - ok: will be set to ``True`` if ``duration`` was successfully parsed and date times could be calculated - - maxValuesExceeded: will be set to ``True`` if the maximum number of values to return was exceeded + - ok: ``True`` if ``duration`` was successfully parsed and date times could be calculated + - maxValuesExceeded: ``True`` if the maximum number of values to return was exceeded .. versionadded:: 3.20 %End @@ -131,8 +131,8 @@ Calculates a complete list of datetimes from a ISO8601 ``string`` containing a d :param maxValues: maximum number of values to return, or -1 to return all values :return: - calculated list of date times - - ok: will be set to ``True`` if ``string`` was successfully parsed and date times could be calculated - - maxValuesExceeded: will be set to ``True`` if the maximum number of values to return was exceeded + - ok: ``True`` if ``string`` was successfully parsed and date times could be calculated + - maxValuesExceeded: ``True`` if the maximum number of values to return was exceeded .. versionadded:: 3.20 %End diff --git a/python/core/auto_generated/qgsunittypes.sip.in b/python/core/auto_generated/qgsunittypes.sip.in index 06525b7d890e..1a9ad2adf9a4 100644 --- a/python/core/auto_generated/qgsunittypes.sip.in +++ b/python/core/auto_generated/qgsunittypes.sip.in @@ -61,7 +61,7 @@ Decodes a unit type from a ``string``. :param string: string to decode :return: - decoded unit type - - ok: boolean, will be set to ``True`` if string was converted successfully + - ok: boolean, ``True`` if string was converted successfully .. seealso:: :py:func:`encodeUnitType` @@ -93,7 +93,7 @@ Decodes a distance unit from a string. :param string: string to decode :return: - decoded units - - ok: boolean, will be set to ``True`` if string was converted successfully + - ok: boolean, ``True`` if string was converted successfully .. seealso:: :py:func:`encodeUnit` %End @@ -123,7 +123,7 @@ Converts a translated string to a distance unit. :param string: string representing a distance unit :return: - the distance unit - - ok: boolean, will be set to ``True`` if string was converted successfully + - ok: boolean, ``True`` if string was converted successfully .. seealso:: :py:func:`toString` %End @@ -162,7 +162,7 @@ Decodes an areal unit from a string. :param string: string to decode :return: - decoded units - - ok: boolean, will be set to ``True`` if string was converted successfully + - ok: boolean, ``True`` if string was converted successfully .. seealso:: :py:func:`encodeUnit` %End @@ -192,7 +192,7 @@ Converts a translated string to an areal unit. :param string: string representing an areal unit :return: - the area unit - - ok: boolean, will be set to ``True`` if string was converted successfully + - ok: boolean, ``True`` if string was converted successfully .. seealso:: :py:func:`toString` %End @@ -246,7 +246,7 @@ Decodes a temporal unit from a ``string``. :param string: string to decode :return: - decoded units - - ok: boolean, will be set to ``True`` if string was converted successfully + - ok: boolean, ``True`` if string was converted successfully .. seealso:: :py:func:`encodeUnit` @@ -278,7 +278,7 @@ Converts a translated ``string`` to a temporal unit. :param string: string representing a volume unit :return: - the temporal unit - - ok: boolean, will be set to ``True`` if string was converted successfully + - ok: boolean, ``True`` if string was converted successfully .. seealso:: :py:func:`toString` @@ -331,7 +331,7 @@ Decodes a volume unit from a ``string``. :param string: string to decode :return: - decoded units - - ok: boolean, will be set to ``True`` if string was converted successfully + - ok: boolean, ``True`` if string was converted successfully .. seealso:: :py:func:`encodeUnit` @@ -363,7 +363,7 @@ Converts a translated ``string`` to a volume unit. :param string: string representing a volume unit :return: - the volume unit - - ok: boolean, will be set to ``True`` if string was converted successfully + - ok: boolean, ``True`` if string was converted successfully .. seealso:: :py:func:`toString` @@ -423,7 +423,7 @@ Decodes an angular unit from a string. :param string: string to decode :return: - decoded units - - ok: boolean, will be set to ``True`` if string was converted successfully + - ok: boolean, ``True`` if string was converted successfully .. seealso:: :py:func:`encodeUnit` %End @@ -523,7 +523,7 @@ Decodes a render unit from a string. :param string: string to decode :return: - decoded units - - ok: boolean, will be set to ``True`` if string was converted successfully + - ok: boolean, ``True`` if string was converted successfully .. seealso:: :py:func:`encodeUnit` %End @@ -563,7 +563,7 @@ Decodes a layout unit from a string. :param string: string to decode :return: - decoded units - - ok: boolean, will be set to ``True`` if string was converted successfully + - ok: boolean, ``True`` if string was converted successfully .. seealso:: :py:func:`encodeUnit` %End diff --git a/python/core/auto_generated/qgsvectorfilewriter.sip.in b/python/core/auto_generated/qgsvectorfilewriter.sip.in index ec7e55ed2eb2..b21aa4bead04 100644 --- a/python/core/auto_generated/qgsvectorfilewriter.sip.in +++ b/python/core/auto_generated/qgsvectorfilewriter.sip.in @@ -255,7 +255,6 @@ Write contents of vector layer to an (OGR supported) vector format :param destCRS: CRS to reproject exported geometries to, or invalid CRS for no reprojection :param driverName: OGR driver to use :param onlySelected: write only selected features of layer -:param errorMessage: will be set to the error message text, if an error occurs while writing the layer :param datasourceOptions: list of OGR data source creation options :param layerOptions: list of OGR layer creation options :param skipAttributeCreation: only write geometries @@ -270,6 +269,8 @@ Write contents of vector layer to an (OGR supported) vector format :param attributes: attributes to export (empty means all unless skipAttributeCreation is set) :param fieldValueConverter: field value converter (added in QGIS 2.16) +:return: - errorMessage: the error message text, if an error occurs while writing the layer + .. deprecated:: 3.40 Use :py:func:`~QgsVectorFileWriter.writeAsVectorFormatV2` instead. @@ -306,7 +307,6 @@ Writes a layer out to a vector file. for no transformation :param driverName: OGR driver to use :param onlySelected: write only selected features of layer -:param errorMessage: will be set to the error message text, if an error occurs while writing the layer :param datasourceOptions: list of OGR data source creation options :param layerOptions: list of OGR layer creation options :param skipAttributeCreation: only write geometries @@ -321,6 +321,8 @@ Writes a layer out to a vector file. :param attributes: attributes to export (empty means all unless skipAttributeCreation is set) :param fieldValueConverter: field value converter (added in QGIS 2.16) +:return: - errorMessage: the error message text, if an error occurs while writing the layer + .. deprecated:: 3.40 Use :py:func:`~QgsVectorFileWriter.writeAsVectorFormatV2` instead. @@ -406,7 +408,8 @@ Writes a layer out to a vector file. :param fileName: file name to write to :param options: options. :param newFilename: QString pointer which will contain the new file name created (in case it is different to fileName). -:param errorMessage: will be set to the error message text, if an error occurs while writing the layer + +:return: - errorMessage: the error message text, if an error occurs while writing the layer .. deprecated:: 3.40 @@ -478,7 +481,7 @@ Writes a layer out to a vector file. :param newLayer: potentially modified layer name (output parameter) :return: - Error message code, or QgsVectorFileWriter.NoError if the write operation was successful - - errorMessage: will be set to the error message text, if an error occurs while writing the layer + - errorMessage: the error message text, if an error occurs while writing the layer .. deprecated:: 3.20 @@ -499,11 +502,11 @@ Writes a layer out to a vector file. :param fileName: file name to write to :param transformContext: coordinate transform context :param options: save options -:param newFilename: potentially modified file name (output parameter) -:param errorMessage: will be set to the error message text, if an error occurs while writing the layer :return: - Error message code, or QgsVectorFileWriter.NoError if the write operation was successful + - newFilename: potentially modified file name (output parameter) - newLayer: potentially modified layer name (output parameter) + - errorMessage: the error message text, if an error occurs while writing the layer .. versionadded:: 3.20 %End diff --git a/python/core/auto_generated/raster/qgsrasterattributetable.sip.in b/python/core/auto_generated/raster/qgsrasterattributetable.sip.in index 0338b7994d5e..71222e9d56eb 100644 --- a/python/core/auto_generated/raster/qgsrasterattributetable.sip.in +++ b/python/core/auto_generated/raster/qgsrasterattributetable.sip.in @@ -359,7 +359,7 @@ Returns a field by name or a default constructed field with empty name if the fi :param name: of the field :return: - the matching field or a default constructed one. - - ok: will be set to ``True`` if the field was found. + - ok: ``True`` if the field was found. %End const QList fieldsByUsage( const Qgis::RasterAttributeTableFieldUsage fieldUsage ) const; diff --git a/python/core/auto_generated/raster/qgsrasterlayerutils.sip.in b/python/core/auto_generated/raster/qgsrasterlayerutils.sip.in index 03a791ed11dd..9326b9ebf6b6 100644 --- a/python/core/auto_generated/raster/qgsrasterlayerutils.sip.in +++ b/python/core/auto_generated/raster/qgsrasterlayerutils.sip.in @@ -38,7 +38,7 @@ respecting any elevation and temporal settings which affect the rendered band. :param elevationRange: elevation range for rendering :return: - Matched band, or -1 if the layer does not have any elevation or temporal settings which affect the rendered band. - - matched: will be set to ``True`` if a band matching the temporal and elevation range was found + - matched: ``True`` if a band matching the temporal and elevation range was found %End }; diff --git a/python/core/auto_generated/raster/qgsrastershader.sip.in b/python/core/auto_generated/raster/qgsrastershader.sip.in index f901f15d17f6..5ae6c0719f3e 100644 --- a/python/core/auto_generated/raster/qgsrastershader.sip.in +++ b/python/core/auto_generated/raster/qgsrastershader.sip.in @@ -55,11 +55,11 @@ Returns the minimum value for the raster shader. Generates a new RGBA value based on one input ``value``. :param value: The original value to base a new RGBA value on -:param returnRedValue: The red component of the new RGBA value -:param returnGreenValue: The green component of the new RGBA value -:param returnBlueValue: The blue component of the new RGBA value :return: - ``True`` if the return values are valid otherwise ``False`` + - returnRedValue: The red component of the new RGBA value + - returnGreenValue: The green component of the new RGBA value + - returnBlueValue: The blue component of the new RGBA value - returnAlpha: The alpha component of the new RGBA value %End @@ -78,11 +78,11 @@ Generates a new RGBA value based on an original RGBA value. :param greenValue: The green component of the original value to base a new RGBA value on :param blueValue: The blue component of the original value to base a new RGBA value on :param alphaValue: The alpha component of the original value to base a new RGBA value on -:param returnRedValue: The red component of the new RGBA value -:param returnGreenValue: The green component of the new RGBA value -:param returnBlueValue: The blue component of the new RGBA value :return: - ``True`` if the return values are valid otherwise ``False`` + - returnRedValue: The red component of the new RGBA value + - returnGreenValue: The green component of the new RGBA value + - returnBlueValue: The blue component of the new RGBA value - returnAlpha: The alpha component of the new RGBA value %End diff --git a/python/core/auto_generated/raster/qgsrastershaderfunction.sip.in b/python/core/auto_generated/raster/qgsrastershaderfunction.sip.in index ee6a5402ed75..f06535e80132 100644 --- a/python/core/auto_generated/raster/qgsrastershaderfunction.sip.in +++ b/python/core/auto_generated/raster/qgsrastershaderfunction.sip.in @@ -59,11 +59,11 @@ Sets the minimum ``value`` for the raster shader. Generates an new RGBA value based on one input ``value``. :param value: The original value to base a new RGBA value on -:param returnRedValue: The red component of the new RGBA value -:param returnGreenValue: The green component of the new RGBA value -:param returnBlueValue: The blue component of the new RGBA value :return: - ``True`` if the return values are valid otherwise ``False`` + - returnRedValue: The red component of the new RGBA value + - returnGreenValue: The green component of the new RGBA value + - returnBlueValue: The blue component of the new RGBA value - returnAlpha: The alpha component of the new RGBA value %End @@ -82,11 +82,11 @@ Generates an new RGBA value based on an original RGBA value. :param greenValue: The green component of the original value to base a new RGBA value on :param blueValue: The blue component of the original value to base a new RGBA value on :param alphaValue: The alpha component of the original value to base a new RGBA value on -:param returnRedValue: The red component of the new RGBA value -:param returnGreenValue: The green component of the new RGBA value -:param returnBlueValue: The blue component of the new RGBA value :return: - ``True`` if the return values are valid otherwise ``False`` + - returnRedValue: The red component of the new RGBA value + - returnGreenValue: The green component of the new RGBA value + - returnBlueValue: The blue component of the new RGBA value - returnAlpha: The alpha component of the new RGBA value %End diff --git a/python/core/auto_generated/symbology/qgsrenderer.sip.in b/python/core/auto_generated/symbology/qgsrenderer.sip.in index df1a42ff8279..4474e37a508f 100644 --- a/python/core/auto_generated/symbology/qgsrenderer.sip.in +++ b/python/core/auto_generated/symbology/qgsrenderer.sip.in @@ -361,7 +361,7 @@ the features displayed using that key. :param layer: associated vector layer :return: - QGIS expression string for matching features with the specified key - - ok: will be set to ``True`` if legend key was successfully converted to a filter expression + - ok: ``True`` if legend key was successfully converted to a filter expression .. seealso:: :py:func:`legendKeys` diff --git a/python/core/auto_generated/symbology/qgssymbollayerutils.sip.in b/python/core/auto_generated/symbology/qgssymbollayerutils.sip.in index e462c4940412..32831d6fc25a 100644 --- a/python/core/auto_generated/symbology/qgssymbollayerutils.sip.in +++ b/python/core/auto_generated/symbology/qgssymbollayerutils.sip.in @@ -67,7 +67,7 @@ Decodes a ``string`` representing a symbol coordinate reference mode. :param string: string to decode :return: - decoded marker clip mode - - ok: will be set to ``True`` if ``string`` was successfully decoded + - ok: ``True`` if ``string`` was successfully decoded .. seealso:: :py:func:`encodeCoordinateReference` @@ -106,7 +106,7 @@ Decodes a ``string`` representing a marker clip mode. :param string: string to decode :return: - decoded marker clip mode - - ok: will be set to ``True`` if ``string`` was successfully decoded + - ok: ``True`` if ``string`` was successfully decoded .. seealso:: :py:func:`encodeMarkerClipMode` @@ -129,7 +129,7 @@ Decodes a ``string`` representing a line clip mode. :param string: string to decode :return: - decoded line clip mode - - ok: will be set to ``True`` if ``string`` was successfully decoded + - ok: ``True`` if ``string`` was successfully decoded .. seealso:: :py:func:`encodeLineClipMode` @@ -170,7 +170,7 @@ Converts a ``value`` to a point. :param value: value to convert :return: - converted point - - ok: will be set to ``True`` if value was successfully converted + - ok: ``True`` if value was successfully converted .. seealso:: :py:func:`decodePoint` @@ -204,7 +204,7 @@ Converts a ``value`` to a size. :param value: value to convert :return: - converted size - - ok: will be set to ``True`` if value was successfully converted + - ok: ``True`` if value was successfully converted .. seealso:: :py:func:`decodeSize` @@ -662,7 +662,7 @@ Attempts to parse mime data as a color :param data: mime data to parse :return: - valid color if mimedata could be interpreted as a color, otherwise an invalid color - - hasAlpha: will be set to ``True`` if mime data was interpreted as a color containing an explicit alpha value + - hasAlpha: ``True`` if mime data was interpreted as a color containing an explicit alpha value %End static QgsNamedColorList colorListFromMimeData( const QMimeData *data ); diff --git a/python/core/auto_generated/textrenderer/qgsfontmanager.sip.in b/python/core/auto_generated/textrenderer/qgsfontmanager.sip.in index 5435541f16be..25eb17204c48 100644 --- a/python/core/auto_generated/textrenderer/qgsfontmanager.sip.in +++ b/python/core/auto_generated/textrenderer/qgsfontmanager.sip.in @@ -197,7 +197,7 @@ font is installed and available for use. :param family: input font family name to try to match to known fonts :return: - ``True`` if match was successful and the download will occur - - matchedFamily: will be set to found font family if a match was successful + - matchedFamily: found font family if a match was successful %End void enableFontDownloadsForSession(); @@ -219,7 +219,7 @@ return an empty string for any font families not present in this list. :param family: input font family name to try to match to known fonts :return: - URL to download font, or an empty string if no URL is available - - matchedFamily: will be set to found font family if a match was successful + - matchedFamily: found font family if a match was successful .. deprecated:: 3.38 @@ -239,7 +239,7 @@ return an invalid :py:class:`QgsFontDownloadDetails` for any font families not p :param family: input font family name to try to match to known fonts :return: - details required for downloading font, or an invalid :py:class:`QgsFontDownloadDetails` if no URL is available - - matchedFamily: will be set to found font family if a match was successful + - matchedFamily: found font family if a match was successful .. versionadded:: 3.38 %End @@ -292,7 +292,7 @@ or a zipped archive of font files. :param extension: known file extension (eg "ttf", "otf") for font. Should be specified to avoid issues with font installation on Windows if filename is not specified (since QGIS 3.38) :return: - ``True`` if installation was successful. - - errorMessage: will be set to a descriptive error message if the installation fails + - errorMessage: a descriptive error message if the installation fails - families: will be populated with a list of font families installed from the data - licenseDetails: will be populated with font license details, if found %End diff --git a/python/core/auto_generated/vector/qgsvectorlayer.sip.in b/python/core/auto_generated/vector/qgsvectorlayer.sip.in index 58c97242a388..1020c8d234aa 100644 --- a/python/core/auto_generated/vector/qgsvectorlayer.sip.in +++ b/python/core/auto_generated/vector/qgsvectorlayer.sip.in @@ -2413,8 +2413,8 @@ and maximum values are required. .. seealso:: :py:func:`maximumValue` -:return: - minimum: will be set to minimum attribute value or an invalid variant in case of error. - - maximum: will be set to maximum attribute value or an invalid variant in case of error. +:return: - minimum: minimum attribute value or an invalid variant in case of error. + - maximum: maximum attribute value or an invalid variant in case of error. .. versionadded:: 3.20 %End diff --git a/python/core/auto_generated/vector/qgsvectorlayereditbuffergroup.sip.in b/python/core/auto_generated/vector/qgsvectorlayereditbuffergroup.sip.in index 213796a3e16f..576f78339917 100644 --- a/python/core/auto_generated/vector/qgsvectorlayereditbuffergroup.sip.in +++ b/python/core/auto_generated/vector/qgsvectorlayereditbuffergroup.sip.in @@ -83,7 +83,7 @@ that the user has some chance of repairing the damage cleanly. Otherwise the layer editing mode will be disabled if the commit is successful. :return: - ``True`` on success - - commitErrors: will be set to a list of descriptive errors if the commit fails. + - commitErrors: a list of descriptive errors if the commit fails. %End bool rollBack( QStringList &rollbackErrors /Out/, bool stopEditing = true ); @@ -94,7 +94,7 @@ Stop editing and discard the edits Otherwise the layer editing mode will be disabled if the rollback is successful. :return: - ``False`` if errors occurred during rollback - - rollbackErrors: will be set to a list of descriptive errors if the rollback fails. + - rollbackErrors: a list of descriptive errors if the rollback fails. %End bool isEditing() const; diff --git a/python/core/auto_generated/vector/qgsvectorlayereditutils.sip.in b/python/core/auto_generated/vector/qgsvectorlayereditutils.sip.in index ed5a080f47d0..e813ba05168a 100644 --- a/python/core/auto_generated/vector/qgsvectorlayereditutils.sip.in +++ b/python/core/auto_generated/vector/qgsvectorlayereditutils.sip.in @@ -327,7 +327,7 @@ Merge features into a single one. :param unionGeometry: is the resulting geometry of the merged feature :return: - ``True`` if the merge was successful, or ``False`` if the operation failed. - - errorMessage: will be set to a descriptive error message if any occurs + - errorMessage: a descriptive error message if any occurs .. versionadded:: 3.30 %End diff --git a/python/core/auto_generated/vector/qgsvectorlayerexporter.sip.in b/python/core/auto_generated/vector/qgsvectorlayerexporter.sip.in index 4fd4e3fe29c8..2f2e60d426b2 100644 --- a/python/core/auto_generated/vector/qgsvectorlayerexporter.sip.in +++ b/python/core/auto_generated/vector/qgsvectorlayerexporter.sip.in @@ -46,11 +46,11 @@ Writes the contents of vector layer to a different datasource. :param destCRS: destination CRS, or an invalid (default constructed) CRS if not available :param onlySelected: set to ``True`` to export only selected features -:param errorMessage: if non-null, will be set to any error messages :param options: optional provider dataset options :param feedback: optional feedback object to show progress and cancellation of export -:return: NoError for a successful export, or encountered error +:return: - NoError for a successful export, or encountered error + - errorMessage: if non-null, any error messages %End QgsVectorLayerExporter( const QString &uri, diff --git a/python/core/auto_generated/vectortile/qgsmapboxglstyleconverter.sip.in b/python/core/auto_generated/vectortile/qgsmapboxglstyleconverter.sip.in index 31ac7b166d4d..4da05bc6bcc4 100644 --- a/python/core/auto_generated/vectortile/qgsmapboxglstyleconverter.sip.in +++ b/python/core/auto_generated/vectortile/qgsmapboxglstyleconverter.sip.in @@ -517,9 +517,6 @@ Parses a symbol layer as renderer or labeling. This is private API only, and may change in future QGIS versions :param jsonLayer: symbol layer to parse -:param rendererStyle: generated QGIS vector tile style -:param hasRenderer: will be set to ``True`` if symbol layer generated a renderer style -:param labelingStyle: generated QGIS vector tile labeling :param context: conversion context %End @@ -547,7 +544,7 @@ Parses a color value which is interpolated by zoom range. :param context: conversion context :return: - :py:class:`QgsProperty` representing interpolation settings - - defaultColor: storage for a reasonable "default" color representing the overall property. + - defaultColor: a reasonable "default" color representing the overall property. %End static QgsProperty parseInterpolateByZoom( const QVariantMap &json, QgsMapBoxGlStyleConversionContext &context, double multiplier = 1, double *defaultNumber /Out/ = 0 ); @@ -559,7 +556,7 @@ Parses a numeric value which is interpolated by zoom range. :param multiplier: optional multiplication factor :return: - :py:class:`QgsProperty` representing interpolation settings - - defaultNumber: storage for a reasonable "default" number representing the overall property. + - defaultNumber: a reasonable "default" number representing the overall property. %End static QgsProperty parseInterpolateOpacityByZoom( const QVariantMap &json, int maxOpacity, QgsMapBoxGlStyleConversionContext *contextPtr = 0 ); diff --git a/python/gui/auto_generated/history/qgshistoryproviderregistry.sip.in b/python/gui/auto_generated/history/qgshistoryproviderregistry.sip.in index df9a93ce0354..68c3a5e725f6 100644 --- a/python/gui/auto_generated/history/qgshistoryproviderregistry.sip.in +++ b/python/gui/auto_generated/history/qgshistoryproviderregistry.sip.in @@ -100,7 +100,7 @@ Entry options are specified via the ``options`` argument. :param options: options :return: - ID of newly added entry. - - ok: will be set to ``True`` if entry was successfully added + - ok: ``True`` if entry was successfully added %End long long addEntry( const QgsHistoryEntry &entry, bool &ok /Out/, QgsHistoryProviderRegistry::HistoryEntryOptions options = QgsHistoryProviderRegistry::HistoryEntryOptions() ); @@ -111,7 +111,7 @@ Adds an ``entry`` to the history logs. :param options: options :return: - ID of newly added entry. - - ok: will be set to ``True`` if entry was successfully added + - ok: ``True`` if entry was successfully added .. seealso:: :py:func:`entryAdded` %End diff --git a/python/gui/auto_generated/qgsattributeform.sip.in b/python/gui/auto_generated/qgsattributeform.sip.in index 935b3bacab93..c81f00bdddaf 100644 --- a/python/gui/auto_generated/qgsattributeform.sip.in +++ b/python/gui/auto_generated/qgsattributeform.sip.in @@ -286,7 +286,7 @@ Save all the values from the editors to the layer. :return: - ``True`` if save was successful - - error: will be set to an explanatory error message if an error occurs while saving the form. + - error: an explanatory error message if an error occurs while saving the form. .. versionadded:: 3.18 %End diff --git a/python/gui/auto_generated/qgsexpressionlineedit.sip.in b/python/gui/auto_generated/qgsexpressionlineedit.sip.in index e139aa32da72..c3e1926ff2d7 100644 --- a/python/gui/auto_generated/qgsexpressionlineedit.sip.in +++ b/python/gui/auto_generated/qgsexpressionlineedit.sip.in @@ -113,7 +113,7 @@ Determines if the current expression is valid. :return: - ``True`` if the current expression is valid. - - expressionError: will be set to any generated error message + - expressionError: any generated error message %End void registerExpressionContextGenerator( const QgsExpressionContextGenerator *generator ); diff --git a/python/gui/auto_generated/qgsnewvectorlayerdialog.sip.in b/python/gui/auto_generated/qgsnewvectorlayerdialog.sip.in index 39eecf139c8c..acee3ed30c19 100644 --- a/python/gui/auto_generated/qgsnewvectorlayerdialog.sip.in +++ b/python/gui/auto_generated/qgsnewvectorlayerdialog.sip.in @@ -48,8 +48,8 @@ If ``encoding`` is specified, it will be set to the encoding of the created file :param crs: default layer CRS to show in dialog :return: - Newly created file name, or an empty string if user canceled or an error occurred. - - errorMessage: will be set to any error message encountered during layer creation - - encoding: will be set to file encoding of created layer + - errorMessage: any error message encountered during layer creation + - encoding: file encoding of created layer .. versionadded:: 3.4.5 %End diff --git a/scripts/sipify.py b/scripts/sipify.py index 699d7bd00702..6c30366746f0 100755 --- a/scripts/sipify.py +++ b/scripts/sipify.py @@ -1206,8 +1206,9 @@ def detect_comment_block(strict_mode=True): CONTEXT.comment_code_snippet = CodeSnippetType.NotCodeSnippet CONTEXT.comment_last_line_note_warning = False CONTEXT.found_since = False - CONTEXT.skipped_params_out = [] - CONTEXT.skipped_params_remove = [] + if CONTEXT.multiline_definition == MultiLineType.NotMultiline: + CONTEXT.skipped_params_out = [] + CONTEXT.skipped_params_remove = [] if re.match(r'^\s*/\*', CONTEXT.current_line) or ( not strict_mode and '/*' in CONTEXT.current_line): @@ -2661,13 +2662,16 @@ def cpp_to_python_signature(cpp_function: str) -> str: param_match = re.match(r'^:param\s+(\w+)', comment_line) if param_match: param_name = param_match.group(1) + dbg_info(f'found parameter: {param_name}') if param_name in CONTEXT.skipped_params_out or param_name in CONTEXT.skipped_params_remove: + dbg_info(str(CONTEXT.skipped_params_out)) if param_name in CONTEXT.skipped_params_out: + dbg_info(f'deferring docs for parameter {param_name} marked as SIP_OUT') comment_line = re.sub( r'^:param\s+(\w+):\s*(.*?)$', r'\1: \2', comment_line) comment_line = re.sub( - r'(?:optional|if specified|if given),?\s*', + r'(?:optional|if specified|if given|storage for|will be set to),?\s*', '', comment_line) out_params.append(comment_line) @@ -2729,7 +2733,7 @@ def cpp_to_python_signature(cpp_function: str) -> str: if out_params and CONTEXT.return_type: exit_with_error( - f"A method with output parameters must contain a return directive (method returns {CONTEXT.return_type})") + f"A method with output parameters must contain a return directive ({CONTEXT.current_method_name} method returns {CONTEXT.return_type})") dbg_info(f'doc_string is {doc_string}') write_output("DS", doc_string) diff --git a/src/core/qgsmaplayer.h b/src/core/qgsmaplayer.h index e6de4ec123ac..0ed80bb37a41 100644 --- a/src/core/qgsmaplayer.h +++ b/src/core/qgsmaplayer.h @@ -785,6 +785,8 @@ class CORE_EXPORT QgsMapLayer : public QObject * \param loadFromLocalDb if TRUE forces to load from local db instead of datasource one * \param categories the style categories to be loaded. * \param flags flags controlling how the style should be loaded (since QGIS 3.38) + * + * \returns status message, which may indicate success or contain an error message */ virtual QString loadNamedStyle( const QString &theURI, bool &resultFlag SIP_OUT, bool loadFromLocalDb, QgsMapLayer::StyleCategories categories = QgsMapLayer::AllStyleCategories, From 391b61544e317067fce0c696466dc41fc749f8d4 Mon Sep 17 00:00:00 2001 From: Nyall Dawson Date: Tue, 10 Sep 2024 11:46:47 +1000 Subject: [PATCH 2/2] Handle SIP_OUT with void functions --- .../network/qgsgraphdirector.sip.in | 3 ++- .../geometry/qgsgeometryutils.sip.in | 4 ++++ .../core/auto_generated/qgsmaplayer.sip.in | 4 ++++ .../qgsgraduatedsymbolrenderer.sip.in | 2 ++ .../vector/qgsvectordataprovider.sip.in | 2 ++ .../qgsmapboxglstyleconverter.sip.in | 8 +++++--- .../network/qgsgraphdirector.sip.in | 3 ++- .../geometry/qgsgeometryutils.sip.in | 4 ++++ python/core/auto_generated/qgsmaplayer.sip.in | 4 ++++ .../qgsgraduatedsymbolrenderer.sip.in | 2 ++ .../vector/qgsvectordataprovider.sip.in | 2 ++ .../qgsmapboxglstyleconverter.sip.in | 5 +++++ scripts/sipify.py | 19 ++++++++++++++++--- 13 files changed, 54 insertions(+), 8 deletions(-) diff --git a/python/PyQt6/analysis/auto_generated/network/qgsgraphdirector.sip.in b/python/PyQt6/analysis/auto_generated/network/qgsgraphdirector.sip.in index 837367ed9826..784d993092de 100644 --- a/python/PyQt6/analysis/auto_generated/network/qgsgraphdirector.sip.in +++ b/python/PyQt6/analysis/auto_generated/network/qgsgraphdirector.sip.in @@ -43,12 +43,13 @@ Make a graph using :py:class:`QgsGraphBuilder` :param builder: the graph builder :param additionalPoints: list of points that should be snapped to the graph -:param snappedPoints: list of snapped points :param feedback: feedback object for reporting progress .. note:: if snappedPoints[i] == QgsPointXY(0.0,0.0) then snapping failed. + +:return: list of snapped points %End void addStrategy( QgsNetworkStrategy *prop /Transfer/ ); diff --git a/python/PyQt6/core/auto_generated/geometry/qgsgeometryutils.sip.in b/python/PyQt6/core/auto_generated/geometry/qgsgeometryutils.sip.in index 8db55ed5e830..23889f5ef499 100644 --- a/python/PyQt6/core/auto_generated/geometry/qgsgeometryutils.sip.in +++ b/python/PyQt6/core/auto_generated/geometry/qgsgeometryutils.sip.in @@ -368,6 +368,10 @@ Returns the coefficients (a, b, c for equation "ax + by + c = 0") of a line defi :param pt1: first point. :param pt2: second point. + +:return: - a: Output parameter, a coefficient of the equation. + - b: Output parameter, b coefficient of the equation. + - c: Output parameter, c coefficient of the equation. %End static QgsLineString perpendicularSegment( const QgsPoint &p, const QgsPoint &s1, const QgsPoint &s2 ) /HoldGIL/; diff --git a/python/PyQt6/core/auto_generated/qgsmaplayer.sip.in b/python/PyQt6/core/auto_generated/qgsmaplayer.sip.in index fe2dddb4ee28..3b9efa46107b 100644 --- a/python/PyQt6/core/auto_generated/qgsmaplayer.sip.in +++ b/python/PyQt6/core/auto_generated/qgsmaplayer.sip.in @@ -799,6 +799,8 @@ Saves named and sld style of the layer to the style table in the db. Since 3.24, calling this method will ALWAYS overwrite any existing style with the same name. Use :py:func:`QgsProviderRegistry.styleExists()` to test in advance if a style already exists and handle this appropriately in your client code. + +:return: a descriptive error message if any occurs %End @@ -1128,6 +1130,8 @@ Export the properties of this layer as named style in a QDomDocument :param context: read write context :param categories: the style categories to export during the execution of writeSymbology + +:return: this QString will be initialized on error %End diff --git a/python/PyQt6/core/auto_generated/symbology/qgsgraduatedsymbolrenderer.sip.in b/python/PyQt6/core/auto_generated/symbology/qgsgraduatedsymbolrenderer.sip.in index 5329cce45bb3..963f2a311886 100644 --- a/python/PyQt6/core/auto_generated/symbology/qgsgraduatedsymbolrenderer.sip.in +++ b/python/PyQt6/core/auto_generated/symbology/qgsgraduatedsymbolrenderer.sip.in @@ -283,6 +283,8 @@ Recalculate classes for a layer :param vl: The layer being rendered (from which data values are calculated) :param nclasses: the number of classes + +:return: Optional parameter for error reporting %End diff --git a/python/PyQt6/core/auto_generated/vector/qgsvectordataprovider.sip.in b/python/PyQt6/core/auto_generated/vector/qgsvectordataprovider.sip.in index 3be38c161915..a8e519413428 100644 --- a/python/PyQt6/core/auto_generated/vector/qgsvectordataprovider.sip.in +++ b/python/PyQt6/core/auto_generated/vector/qgsvectordataprovider.sip.in @@ -214,6 +214,8 @@ Returns the possible enum values of an attribute. Returns an empty stringlist if or if the given attribute is not an enum type. :param index: the index of the attribute + +:return: reference to the list to fill %End virtual bool addFeatures( QgsFeatureList &flist /In,Out/, QgsFeatureSink::Flags flags = QgsFeatureSink::Flags() ); diff --git a/python/PyQt6/core/auto_generated/vectortile/qgsmapboxglstyleconverter.sip.in b/python/PyQt6/core/auto_generated/vectortile/qgsmapboxglstyleconverter.sip.in index 20213b22da9d..bfcbc09051c6 100644 --- a/python/PyQt6/core/auto_generated/vectortile/qgsmapboxglstyleconverter.sip.in +++ b/python/PyQt6/core/auto_generated/vectortile/qgsmapboxglstyleconverter.sip.in @@ -517,10 +517,12 @@ Parses a symbol layer as renderer or labeling. This is private API only, and may change in future QGIS versions :param jsonLayer: symbol layer to parse -:param rendererStyle: generated QGIS vector tile style -:param hasRenderer: will be set to ``True`` if symbol layer generated a renderer style -:param labelingStyle: generated QGIS vector tile labeling :param context: conversion context + +:return: - rendererStyle: generated QGIS vector tile style + - hasRenderer: ``True`` if symbol layer generated a renderer style + - labelingStyle: generated QGIS vector tile labeling + - hasLabeling: ``True`` if symbol layer generated a labeling style %End static bool parseSymbolLayerAsRenderer( const QVariantMap &jsonLayer, diff --git a/python/analysis/auto_generated/network/qgsgraphdirector.sip.in b/python/analysis/auto_generated/network/qgsgraphdirector.sip.in index 837367ed9826..784d993092de 100644 --- a/python/analysis/auto_generated/network/qgsgraphdirector.sip.in +++ b/python/analysis/auto_generated/network/qgsgraphdirector.sip.in @@ -43,12 +43,13 @@ Make a graph using :py:class:`QgsGraphBuilder` :param builder: the graph builder :param additionalPoints: list of points that should be snapped to the graph -:param snappedPoints: list of snapped points :param feedback: feedback object for reporting progress .. note:: if snappedPoints[i] == QgsPointXY(0.0,0.0) then snapping failed. + +:return: list of snapped points %End void addStrategy( QgsNetworkStrategy *prop /Transfer/ ); diff --git a/python/core/auto_generated/geometry/qgsgeometryutils.sip.in b/python/core/auto_generated/geometry/qgsgeometryutils.sip.in index 8db55ed5e830..23889f5ef499 100644 --- a/python/core/auto_generated/geometry/qgsgeometryutils.sip.in +++ b/python/core/auto_generated/geometry/qgsgeometryutils.sip.in @@ -368,6 +368,10 @@ Returns the coefficients (a, b, c for equation "ax + by + c = 0") of a line defi :param pt1: first point. :param pt2: second point. + +:return: - a: Output parameter, a coefficient of the equation. + - b: Output parameter, b coefficient of the equation. + - c: Output parameter, c coefficient of the equation. %End static QgsLineString perpendicularSegment( const QgsPoint &p, const QgsPoint &s1, const QgsPoint &s2 ) /HoldGIL/; diff --git a/python/core/auto_generated/qgsmaplayer.sip.in b/python/core/auto_generated/qgsmaplayer.sip.in index f2eb58f76947..99feb6df71ba 100644 --- a/python/core/auto_generated/qgsmaplayer.sip.in +++ b/python/core/auto_generated/qgsmaplayer.sip.in @@ -799,6 +799,8 @@ Saves named and sld style of the layer to the style table in the db. Since 3.24, calling this method will ALWAYS overwrite any existing style with the same name. Use :py:func:`QgsProviderRegistry.styleExists()` to test in advance if a style already exists and handle this appropriately in your client code. + +:return: a descriptive error message if any occurs %End @@ -1128,6 +1130,8 @@ Export the properties of this layer as named style in a QDomDocument :param context: read write context :param categories: the style categories to export during the execution of writeSymbology + +:return: this QString will be initialized on error %End diff --git a/python/core/auto_generated/symbology/qgsgraduatedsymbolrenderer.sip.in b/python/core/auto_generated/symbology/qgsgraduatedsymbolrenderer.sip.in index c81f3da1e3ae..972782259362 100644 --- a/python/core/auto_generated/symbology/qgsgraduatedsymbolrenderer.sip.in +++ b/python/core/auto_generated/symbology/qgsgraduatedsymbolrenderer.sip.in @@ -283,6 +283,8 @@ Recalculate classes for a layer :param vl: The layer being rendered (from which data values are calculated) :param nclasses: the number of classes + +:return: Optional parameter for error reporting %End diff --git a/python/core/auto_generated/vector/qgsvectordataprovider.sip.in b/python/core/auto_generated/vector/qgsvectordataprovider.sip.in index dc033601967c..3e4129505a5e 100644 --- a/python/core/auto_generated/vector/qgsvectordataprovider.sip.in +++ b/python/core/auto_generated/vector/qgsvectordataprovider.sip.in @@ -214,6 +214,8 @@ Returns the possible enum values of an attribute. Returns an empty stringlist if or if the given attribute is not an enum type. :param index: the index of the attribute + +:return: reference to the list to fill %End virtual bool addFeatures( QgsFeatureList &flist /In,Out/, QgsFeatureSink::Flags flags = QgsFeatureSink::Flags() ); diff --git a/python/core/auto_generated/vectortile/qgsmapboxglstyleconverter.sip.in b/python/core/auto_generated/vectortile/qgsmapboxglstyleconverter.sip.in index 4da05bc6bcc4..8fb66394254d 100644 --- a/python/core/auto_generated/vectortile/qgsmapboxglstyleconverter.sip.in +++ b/python/core/auto_generated/vectortile/qgsmapboxglstyleconverter.sip.in @@ -518,6 +518,11 @@ Parses a symbol layer as renderer or labeling. :param jsonLayer: symbol layer to parse :param context: conversion context + +:return: - rendererStyle: generated QGIS vector tile style + - hasRenderer: ``True`` if symbol layer generated a renderer style + - labelingStyle: generated QGIS vector tile labeling + - hasLabeling: ``True`` if symbol layer generated a labeling style %End static bool parseSymbolLayerAsRenderer( const QVariantMap &jsonLayer, diff --git a/scripts/sipify.py b/scripts/sipify.py index 6c30366746f0..931e8b7ea09f 100755 --- a/scripts/sipify.py +++ b/scripts/sipify.py @@ -2731,9 +2731,22 @@ def cpp_to_python_signature(cpp_function: str) -> str: else: pass # Return docstring should be single line with SIP_OUT params - if out_params and CONTEXT.return_type: - exit_with_error( - f"A method with output parameters must contain a return directive ({CONTEXT.current_method_name} method returns {CONTEXT.return_type})") + if out_params: + if CONTEXT.return_type: + exit_with_error( + f"A method with output parameters must contain a return directive ({CONTEXT.current_method_name} method returns {CONTEXT.return_type})") + else: + doc_string += "\n" + + for out_param_idx, out_param in enumerate(out_params): + if out_param_idx == 0: + if len(out_params) > 1: + doc_string += f":return: - {out_param}\n" + else: + arg_name_match = re.match(r'^(.*?):\s*(.*?)$', out_param) + doc_string += f":return: {arg_name_match.group(2)}\n" + else: + doc_string += f"{doc_prepend} - {out_param}\n" dbg_info(f'doc_string is {doc_string}') write_output("DS", doc_string)