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

Valid improvements from new sipify

Browse Source
This commit is contained in:
Nyall Dawson 2024-08-10 17:47:41 +10:00
parent f523c3429e
commit be8dce7d0d
232 changed files with 158 additions and 628 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

2
python/PyQt6/analysis/auto_generated/interpolation/qgsinterpolator.sip.in
View File

@ -20,7 +20,7 @@ struct QgsInterpolatorVertexData
QgsInterpolatorVertexData( double x, double y, double z );
%Docstring
Constructor for :py:class:`QgsInterpolatorVertexData` with the specified
Constructor for QgsInterpolatorVertexData with the specified
``x``, ``y``, and ``z`` coordinate.
%End

6
python/PyQt6/analysis/auto_generated/vector/qgsgeometrysnapper.sip.in
View File

@ -77,10 +77,10 @@ class QgsInternalGeometrySnapper
:py:class:`QgsInternalGeometrySnapper` allows a set of geometries to be snapped to each other. It can be used to close gaps in layers.
To use :py:class:`QgsInternalGeometrySnapper`, first construct the snapper using the desired snap parameters. Then,
features are fed to to the snapper one-by-one by calling :py:func:`~QgsGeometrySnapper.snapFeature`. Each feature passed by calling
:py:func:`~QgsGeometrySnapper.snapFeature` will be snapped to any features which have already been processed by the snapper.
features are fed to to the snapper one-by-one by calling :py:func:`~snapFeature`. Each feature passed by calling
:py:func:`~snapFeature` will be snapped to any features which have already been processed by the snapper.
After processing all desired features, the results can be fetched by calling :py:func:`~QgsGeometrySnapper.snappedGeometries`.
After processing all desired features, the results can be fetched by calling :py:func:`~snappedGeometries`.
The returned :py:class:`QgsGeometryMap` can be passed to :py:func:`QgsVectorDataProvider.changeGeometryValues()` to save
the snapped geometries back to the source layer.
%End

2
python/PyQt6/core/auto_generated/browser/qgsfieldsitem.sip.in
View File

@ -96,7 +96,7 @@ class QgsFieldItem : QgsDataItem
%Docstring(signature="appended")
A layer field item, information about the connection URI, the schema and the
table as well as the layer instance the field belongs to can be retrieved
from the parent QgsFieldsItem object.
from the parent :py:class:`QgsFieldsItem` object.
.. versionadded:: 3.16
%End

1
python/PyQt6/core/auto_generated/classification/qgsclassificationmethod.sip.in
View File

@ -263,7 +263,6 @@ This will calculate the classes for a given layer to define the classes.
:return: - list of generated classes
- error: will be set to error string if an error occurred while generating the classes
.. versionadded:: 3.38
%End

1
python/PyQt6/core/auto_generated/editform/qgseditformconfig.sip.in
View File

@ -124,7 +124,6 @@ Example
:return: ``False`` if a field exists with the provided widgetName. In this case
:py:class:`QgsVectorLayer`.setEditorWidgetSetup should be used.
.. seealso:: :py:func:`QgsVectorLayer.setEditorWidgetSetup`
%End

2
python/PyQt6/core/auto_generated/elevation/qgsabstractprofilegenerator.sip.in
View File

@ -369,7 +369,7 @@ The scenario will be:
additional calls to the source.
# profile job (still in GUI thread) stores the generator for later use.
# profile job (in worker thread) calls :py:func:`QgsAbstractProfileGenerator.generateProfile()`
# profile job (again in GUI thread) will check :py:func:`~QgsProfileGenerationContext.errors` and report them
# profile job (again in GUI thread) will check :py:func:`~errors` and report them
.. versionadded:: 3.26
%End

1
python/PyQt6/core/auto_generated/expression/qgsexpression.sip.in
View File

@ -183,7 +183,6 @@ Gets list of columns referenced by the expression.
If you are seeking to use these functions to introspect an expression you must
take care to do this with an unprepared expression.
.. seealso:: :py:func:`referencedAttributeIndexes`
%End

2
python/PyQt6/core/auto_generated/externalstorage/qgsexternalstorage.sip.in
View File

@ -91,7 +91,7 @@ Fetches file from ``url`` using ``authCfg`` for this project external storage.
class QgsExternalStorageContent : QObject
{
%Docstring(signature="appended")
Base class for QgsExternalStorage stored and fetched content
Base class for :py:class:`QgsExternalStorage` stored and fetched content
.. versionadded:: 3.22
%End

3
python/PyQt6/core/auto_generated/geometry/qgsabstractgeometry.sip.in
View File

@ -786,7 +786,6 @@ Checks validity of the geometry, and returns ``True`` if the geometry is valid.
:return: - ``True`` if geometry is valid
- error: will be set to the validity error message
.. versionadded:: 3.8
%End
@ -865,8 +864,6 @@ Example
for v in geometry.vertices():
print(v.x(), v.y())
.. seealso:: :py:func:`parts`
%End

1
python/PyQt6/core/auto_generated/geometry/qgscircle.sip.in
View File

@ -160,7 +160,6 @@ Example
.. code-block:: python
# [(0 0), (5 0)] and [(5 5), (10 5)] are parallels
QgsCircle.from3TangentsMulti(QgsPoint(0, 0), QgsPoint(5, 0), QgsPoint(5, 5), QgsPoint(10, 5), QgsPoint(2.5, 0), QgsPoint(7.5, 5))
# [<QgsCircle: Circle (Center: Point (8.53553390593273775 2.5), Radius: 2.5, Azimuth: 0)>, <QgsCircle: Circle (Center: Point (1.46446609406726203 2.49999999999999911), Radius: 2.5, Azimuth: 0)>]

1
python/PyQt6/core/auto_generated/geometry/qgscircularstring.sip.in
View File

@ -139,7 +139,6 @@ Appends the contents of another circular ``string`` to the end of this circular
It is the caller's responsibility to ensure that the first point in the appended
``string`` matches the last point in the existing curve, or the result will be undefined.
.. versionadded:: 3.20
%End

1
python/PyQt6/core/auto_generated/geometry/qgscurve.sip.in
View File

@ -319,7 +319,6 @@ Scrolls the curve vertices so that they start with the vertex at the given index
The ``firstVertexIndex`` must correspond to a segment vertex and not a curve point or the result
is undefined.
.. versionadded:: 3.20
%End

9
python/PyQt6/core/auto_generated/geometry/qgsgeometry.sip.in
View File

@ -78,14 +78,14 @@ so making copies of geometries is inexpensive. The geometry container class can
a QVariant object.
The actual geometry representation is stored as a :py:class:`QgsAbstractGeometry` within the container, and
can be accessed via the :py:func:`~QgsGeometryParameters.get` method or set using the :py:func:`~QgsGeometryParameters.set` method. This gives access to the underlying
can be accessed via the :py:func:`~get` method or set using the :py:func:`~set` method. This gives access to the underlying
raw geometry primitive, such as the point, line, polygon, curve or other geometry subclasses.
.. note::
:py:class:`QgsGeometry` objects are inherently Cartesian/planar geometries. They have no concept of geodesy, and none
of the methods or properties exposed from the :py:class:`QgsGeometry` API (or :py:class:`QgsAbstractGeometry` subclasses) utilize
geodesic calculations. Accordingly, properties like :py:func:`~QgsGeometryParameters.length` and :py:func:`~QgsGeometryParameters.area` or spatial operations like :py:func:`~QgsGeometryParameters.buffer`
geodesic calculations. Accordingly, properties like :py:func:`~length` and :py:func:`~area` or spatial operations like :py:func:`~buffer`
are always calculated using strictly Cartesian mathematics. In contrast, the :py:class:`QgsDistanceArea` class exposes
methods for working with geodesic calculations and spatial operations on geometries,
and should be used whenever calculations which account for the curvature of the Earth (or any other celestial body)
@ -462,8 +462,6 @@ Example
for v in geometry.vertices():
print(v.x(), v.y())
.. seealso:: :py:func:`parts`
%End
@ -1674,7 +1672,6 @@ This method requires QGIS builds based on GEOS 3.9 or later.
:raises QgsNotSupportedException: on QGIS builds based on GEOS 3.8 or earlier.
.. versionadded:: 3.20
%End
@ -2534,7 +2531,6 @@ Returns True if the Polygon is counter-clockwise.
returns false if the geometry is not a polygon type or empty
.. seealso:: :py:func:`isPolygonClockwise`
.. seealso:: :py:func:`forcePolygonClockwise`
@ -2557,7 +2553,6 @@ Returns True if the Polygon is clockwise.
returns true if the geometry is not a polygon type or empty
.. seealso:: :py:func:`isPolygonCounterClockwise`
.. seealso:: :py:func:`forcePolygonClockwise`

1
python/PyQt6/core/auto_generated/geometry/qgsgeometrytransformer.sip.in
View File

@ -41,7 +41,6 @@ Example
A transformer which multiples the x coordinate by 3 and adds 10 to the y coordinate:
.. code-block:: python
class MyTransformer(QgsAbstractGeometryTransformer):

7
python/PyQt6/core/auto_generated/geometry/qgsgeometryutils.sip.in
View File

@ -398,7 +398,6 @@ already contains a Z value.
This method does not copy the z value of the coordinate from the
points whose z value is closest to the original x/y point, but only the first one found.
.. deprecated:: QGIS 3.20
use transferFirstZValueToPoint( const :py:class:`QgsPointSequence` &points, :py:class:`QgsPoint` &point ) instead
%End
@ -420,7 +419,6 @@ already contains a Z value.
This method does not copy the z value of the coordinate from the
points whose z value is closest to the original x/y point, but only the first one found.
.. versionadded:: 3.20
%End
@ -441,7 +439,6 @@ already contains a M value.
This method does not copy the m value of the coordinate from the
points whose m value is closest to the original x/y point, but only the first one found.
.. versionadded:: 3.20
%End
@ -464,7 +461,6 @@ looping twice over the set of points.
This method does not copy the z or m value of the coordinate from the
points whose z or m value is closest to the original x/y point, but only the first one found.
.. versionadded:: 3.20
%End
@ -486,7 +482,6 @@ looping twice over the set of points.
This method does not copy the z or m value of the coordinate from the
points whose z or m value is closest to the original x/y point, but only the first one found.
.. versionadded:: 3.20
%End
@ -588,8 +583,6 @@ Example
x, y = QgsGeometryUtils.perpendicularOffsetPointAlongSegment( 1, 5, 11, 5, 0.5, -2 )
# (6.0, 7.0)
:return: - x: calculated point x-coordinate
- y: calculated point y-coordinate

2
python/PyQt6/core/auto_generated/geometry/qgsgeometryutils_base.sip.in
View File

@ -93,8 +93,6 @@ Example
x, y = QgsGeometryUtils.perpendicularOffsetPointAlongSegment( 1, 5, 11, 5, 0.5, -2 )
# (6.0, 7.0)
:return: - x: calculated point x-coordinate
- y: calculated point y-coordinate

2
python/PyQt6/core/auto_generated/geometry/qgsvertexid.sip.in
View File

@ -14,7 +14,7 @@ struct QgsVertexId
explicit QgsVertexId( int _part = -1, int _ring = -1, int _vertex = -1, Qgis::VertexType _type = Qgis::VertexType::Segment ) /HoldGIL/;
%Docstring
Constructor for :py:class:`QgsVertexId`.
Constructor for QgsVertexId.
%End
bool isValid() const /HoldGIL/;

1
python/PyQt6/core/auto_generated/geometry/qgswkbtypes.sip.in
View File

@ -91,7 +91,6 @@ Returns the curve type for a WKB type. For example, for Polygon WKB types the cu
.. seealso:: :py:func:`multiType`
.. versionadded:: 3.10
%End

2
python/PyQt6/core/auto_generated/layout/qgslayoutguidecollection.sip.in
View File

@ -263,7 +263,7 @@ Sets the collection's state from a DOM element. collectionElement is the DOM nod
class QgsLayoutGuideProxyModel : QSortFilterProxyModel
{
%Docstring(signature="appended")
Filters QgsLayoutGuideCollection models to guides of a single orientation (horizontal or vertical).
Filters :py:class:`QgsLayoutGuideCollection` models to guides of a single orientation (horizontal or vertical).
%End
%TypeHeaderCode

2
python/PyQt6/core/auto_generated/layout/qgslayoutmanager.sip.in
View File

@ -224,7 +224,7 @@ class QgsLayoutManagerProxyModel : QSortFilterProxyModel
{
%Docstring(signature="appended")
QSortFilterProxyModel subclass for QgsLayoutManagerModel
QSortFilterProxyModel subclass for :py:class:`QgsLayoutManagerModel`
.. versionadded:: 3.8
%End

2
python/PyQt6/core/auto_generated/layout/qgslayoutmodel.sip.in
View File

@ -96,7 +96,7 @@ Returns the QModelIndex corresponding to a :py:class:`QgsLayoutItem` ``item`` an
class QgsLayoutProxyModel: QSortFilterProxyModel
{
%Docstring(signature="appended")
Allows for filtering a QgsLayoutModel by item type.
Allows for filtering a :py:class:`QgsLayoutModel` by item type.
%End
%TypeHeaderCode

1
python/PyQt6/core/auto_generated/layout/qgslayoutrendercontext.sip.in
View File

@ -249,7 +249,6 @@ The default is to use no simplification.
.. seealso:: :py:func:`simplifyMethod`
.. versionadded:: 3.10
%End

6
python/PyQt6/core/auto_generated/locator/qgslocatormodel.sip.in
View File

@ -82,14 +82,14 @@ Adds a new ``result`` to the model.
class QgsLocatorAutomaticModel : QgsLocatorModel
{
%Docstring(signature="appended")
A QgsLocatorModel which has is associated directly with a
A :py:class:`QgsLocatorModel` which has is associated directly with a
:py:class:`QgsLocator`, and is automatically populated with results
from locator searches.
Use this QgsLocatorModel subclass when you want the connections
Use this :py:class:`QgsLocatorModel` subclass when you want the connections
between a :py:class:`QgsLocator` and the model to be automatically created
for you. If more flexibility in model behavior is required,
use the base QgsLocatorModel class instead and setup the
use the base :py:class:`QgsLocatorModel` class instead and setup the
connections manually.
Note that this class should generally be used with a :py:class:`QgsLocatorProxyModel`

6
python/PyQt6/core/auto_generated/mesh/qgsmesh3daveraging.sip.in
View File

@ -259,14 +259,14 @@ class QgsMeshRelativeHeightAveragingMethod: QgsMesh3DAveragingMethod
{
%Docstring(signature="appended")
Relative height averaging method averages the values based on range defined relative to bed elevation or surface (when :py:func:`~QgsMeshSigmaAveragingMethod.countedFromTop`)
Relative height averaging method averages the values based on range defined relative to bed elevation or surface (when :py:func:`~countedFromTop`)
The range is defined in the same length units as defined by model (e.g. meters)
if :py:func:`~QgsMeshSigmaAveragingMethod.countedFromTop`, the method represents averaging based on depth below surface.
if :py:func:`~countedFromTop`, the method represents averaging based on depth below surface.
For example one can pull out results for between 6 to 12 meters below the water surface - depth from 6m to 12m.
The depth will be truncated at the bed level.
if not :py:func:`~QgsMeshSigmaAveragingMethod.countedFromTop`, the method represents averaging based on height above bed level.
if not :py:func:`~countedFromTop`, the method represents averaging based on height above bed level.
For example one can pull out results for between 6 to 12 meters above the bed - height from 6m to 12m.
The height will be truncated at the bed level.

2
python/PyQt6/core/auto_generated/mesh/qgsmeshadvancedediting.sip.in
View File

@ -98,7 +98,7 @@ class QgsMeshTransformVerticesByExpression : QgsMeshAdvancedEditing
Class that can transform vertices of a mesh by expression
Each coordinates are associated with an expression that can be defined with function
returning the current coordinates (see :py:func:`~QgsMeshEditRefineFaces.setExpressions`):
returning the current coordinates (see :py:func:`~setExpressions`):
- $vertex_x
- $vertex_y

4
python/PyQt6/core/auto_generated/mesh/qgsmeshdataprovider.sip.in
View File

@ -169,7 +169,6 @@ Saves the ``mesh`` frame to the source.
:return: ``True`` on success
.. versionadded:: 3.22
%End
};
@ -325,7 +324,6 @@ On success, the mesh's dataset group count is changed
Doesn't work if there is ":" in the path (e.g. Windows system)
.. versionadded:: 3.6
.. deprecated::
@ -376,7 +374,6 @@ On success, the mesh's dataset group count is changed
:return: ``True`` on failure, ``False`` on success
.. versionadded:: 3.16
%End
@ -409,7 +406,6 @@ Returns a list of dataset indexes of the dataset in a specific dataset group tha
:return: the dataset index
.. versionadded:: 3.22
%End

5
python/PyQt6/core/auto_generated/mesh/qgsmeshdataset.sip.in
View File

@ -136,8 +136,8 @@ vectors (e.g. vector dataset doubles x,y values)
data are implicitly shared, so the class can be quickly copied
std.numeric_limits<double>.quiet_NaN() represents NODATA value
Data can be accessed all at once with :py:func:`~QgsMeshDatasetValue.values` (faster) or
value by value (slower) with :py:func:`~QgsMeshDatasetValue.active` or :py:func:`~QgsMeshDatasetValue.value`
Data can be accessed all at once with :py:func:`~values` (faster) or
value by value (slower) with :py:func:`~active` or :py:func:`~value`
.. versionadded:: 3.6
%End
@ -263,7 +263,6 @@ std.numeric_limits<double>.quiet_NaN() represents NODATA value
In QGIS 3.34 this class was renamed from :py:class:`QgsMesh3dDataBlock` to :py:class:`QgsMesh3DDataBlock`. The old :py:class:`QgsMesh3dDataBlock` name
remains available in PyQGIS for compatibility.
.. versionadded:: 3.12
%End

4
python/PyQt6/core/auto_generated/mesh/qgsmeshforcebypolylines.sip.in
View File

@ -65,11 +65,11 @@ class QgsMeshEditForceByPolylines : QgsMeshEditForceByLine
{
%Docstring(signature="appended")
Class derived from QgsMeshEditForceByLine that forces mesh based on polyline.
Class derived from :py:class:`QgsMeshEditForceByLine` that forces mesh based on polyline.
Forcing lines consist of line that the faces are forced to follow, that is edges of encountered faces have to be on theses lines.
Caller of this class has to add the lines from :py:class:`QgsGeometry` instances with :py:func:`~QgsMeshEditForceByLine.addLineFromGeometry` or :py:func:`~QgsMeshEditForceByLine.addLinesFromGeometries`
Caller of this class has to add the lines from :py:class:`QgsGeometry` instances with :py:func:`~addLineFromGeometry` or :py:func:`~addLinesFromGeometries`
before applying the edition with :py:func:`QgsMeshEditor.advancedEdit()`
.. versionadded:: 3.22

22
python/PyQt6/core/auto_generated/mesh/qgsmeshlayer.sip.in
View File

@ -59,19 +59,15 @@ MDAL data provider (mdal)
Accesses data using the MDAL drivers (https://github.com/lutraconsulting/MDAL). The url
is the MDAL connection string. QGIS must be built with MDAL support to allow this provider.
.. code-block:: python
uri = "test/land.2dm"
scratchLayer = QgsMeshLayer(uri, "My Scratch Layer", "mdal")
.. note::
The API is considered EXPERIMENTAL and can be changed without a notice
.. versionadded:: 3.2
%End
@ -320,7 +316,6 @@ Returns the dataset count in the dataset groups
indexes are used to distinguish all the dataset groups handled by the layer (from dataprovider, extra dataset group,...)
In the layer scope, those indexes can be different from the data provider indexes.
.. versionadded:: 3.16
%End
@ -335,7 +330,6 @@ Returns the dataset metadata
indexes are used to distinguish all the dataset groups handled by the layer (from dataprovider, extra dataset group,...)
In the layer scope, those indexes can be different from the data provider indexes.
.. versionadded:: 3.16
%End
@ -357,7 +351,6 @@ Returns invalid value for DataOnVolumes
indexes are used to distinguish all the dataset groups handled by the layer (from dataprovider, extra dataset group,...)
In the layer scope, those indexes can be different from the data provider indexes.
.. versionadded:: 3.16
%End
@ -380,7 +373,6 @@ need block for any type of data type
indexes are used to distinguish all the dataset groups handled by the layer (from dataprovider, extra dataset group,...)
In the layer scope, those indexes can be different from the data provider indexes.
.. versionadded:: 3.16
%End
@ -401,7 +393,6 @@ returns invalid block for DataOnFaces and DataOnVertices.
indexes are used to distinguish all the dataset groups handled by the layer (from dataprovider, extra dataset group,...)
In the layer scope, those indexes can be different from the data provider indexes.
.. versionadded:: 3.16
%End
@ -427,7 +418,6 @@ Returns whether the faces are active for particular dataset
indexes are used to distinguish all the dataset groups handled by the layer (from dataprovider, extra dataset group,...)
In the layer scope, those indexes are different from the data provider indexes.
.. versionadded:: 3.16
%End
@ -453,13 +443,11 @@ For 1D datasets, it uses :py:func:`~QgsMeshLayer.dataset1dValue` with ``searchRa
outside the mesh layer, nodata values and in case triangular mesh was not
previously used for rendering
.. note::
indexes are used to distinguish all the dataset groups handled by the layer (from dataprovider, extra dataset group,...)
In the layer scope, those indexes are different from the data provider indexes.
.. versionadded:: 3.4
%End
@ -482,13 +470,11 @@ Returns the 3d values of stacked 3d mesh defined by the given point
for point outside the mesh layer or in case triangular mesh was not
previously used for rendering or for datasets that do not have type DataOnVolumes
.. note::
indexes are used to distinguish all the dataset groups handled by the layer (from dataprovider, extra dataset group,...)
In the layer scope, those indexes are different from the data provider indexes.
.. versionadded:: 3.12
%End
@ -511,13 +497,11 @@ Returns the value of 1D mesh dataset defined on edge that are in the search area
:return: interpolated value at the projected point. Returns NaN values for values
outside the mesh layer and in case triangular mesh was not previously used for rendering
.. note::
indexes are used to distinguish all the dataset groups handled by the layer (from dataprovider, extra dataset group,...)
In the layer scope, those indexes are different from the data provider indexes.
.. versionadded:: 3.14
%End
@ -535,13 +519,11 @@ If the temporal properties is not active, returns invalid dataset index. This me
the returned dataset index depends on the matching method, see :py:func:`~QgsMeshLayer.setTemporalMatchingMethod`
.. note::
indexes are used to distinguish all the dataset groups handled by the layer (from dataprovider, extra dataset group,...)
In the layer scope, those indexes are different from the data provider indexes.
.. versionadded:: 3.14
%End
@ -559,13 +541,11 @@ Dataset index is valid even the temporal properties is inactive. This method is
the returned dataset index depends on the matching method, see :py:func:`~QgsMeshLayer.setTemporalMatchingMethod`
.. note::
indexes are used to distinguish all the dataset groups handled by the layer (from dataprovider, extra dataset group,...)
In the layer scope, those indexes are different from the data provider indexes.
.. versionadded:: 3.16
%End
@ -585,7 +565,6 @@ Dataset index is valid even the temporal properties is inactive. This method is
indexes are used to distinguish all the dataset groups handled by the layer (from dataprovider, extra dataset group,...)
In the layer scope, those indexes are different from the data provider indexes.
.. versionadded:: 3.22
%End
@ -683,7 +662,6 @@ The returned position is in map coordinates.
:return: the position of the snapped point on the closest element, empty :py:class:`QgsPointXY` if no element of type ``elementType``
.. versionadded:: 3.14
%End

4
python/PyQt6/core/auto_generated/mesh/qgsmeshlayerelevationproperties.sip.in
View File

@ -81,7 +81,6 @@ Returns the fixed elevation range for the mesh.
When a fixed range is set any :py:func:`~QgsMeshLayerElevationProperties.zOffset` and :py:func:`~QgsMeshLayerElevationProperties.zScale` is ignored.
.. seealso:: :py:func:`setFixedRange`
.. versionadded:: 3.38
@ -99,7 +98,6 @@ Sets the fixed elevation ``range`` for the mesh.
When a fixed range is set any :py:func:`~QgsMeshLayerElevationProperties.zOffset` and :py:func:`~QgsMeshLayerElevationProperties.zScale` is ignored.
.. seealso:: :py:func:`fixedRange`
.. versionadded:: 3.38
@ -117,7 +115,6 @@ Returns the fixed elevation range for each group.
When a fixed range is set any :py:func:`~QgsMeshLayerElevationProperties.zOffset` and :py:func:`~QgsMeshLayerElevationProperties.zScale` is ignored.
.. seealso:: :py:func:`setFixedRangePerGroup`
.. versionadded:: 3.38
@ -135,7 +132,6 @@ Sets the fixed elevation range for each group.
When a fixed range is set any :py:func:`~QgsMeshLayerElevationProperties.zOffset` and :py:func:`~QgsMeshLayerElevationProperties.zScale` is ignored.
.. seealso:: :py:func:`fixedRangePerGroup`
.. versionadded:: 3.38

2
python/PyQt6/core/auto_generated/mesh/qgsmeshlayertemporalproperties.sip.in
View File

@ -33,8 +33,6 @@ The time in a mesh layer is defined by :
AT : absolute time (QDateTime)
RT : relative time (qint64)
.. versionadded:: 3.14
%End

1
python/PyQt6/core/auto_generated/mesh/qgsmeshspatialindex.sip.in
View File

@ -27,7 +27,6 @@ A spatial index for :py:class:`QgsMeshFace` or :py:class:`QgsMeshEdge` objects.
.. seealso:: :py:class:`QgsSpatialIndex`
.. versionadded:: 3.6
%End

2
python/PyQt6/core/auto_generated/network/qgsnewsfeedmodel.sip.in
View File

@ -61,7 +61,7 @@ must exist for the lifetime of this model.
class QgsNewsFeedProxyModel : QSortFilterProxyModel
{
%Docstring(signature="appended")
A proxy model for use with QgsNewsFeedModel.
A proxy model for use with :py:class:`QgsNewsFeedModel`.
:py:class:`QgsNewsFeedProxyModel` applies custom sorting to the entries in a :py:class:`QgsNewsFeedModel`.

1
python/PyQt6/core/auto_generated/painting/qgspainting.sip.in
View File

@ -62,7 +62,6 @@ to the triangle defined by (``outX1``, ``outY1``), (``outY2``, ``outY2``), (``ou
:return: - Calculated transform (if possible)
- ok: will be set to ``True`` if the transform could be determined.
.. versionadded:: 3.34
%End

2
python/PyQt6/core/auto_generated/plot/qgsplot.sip.in
View File

@ -233,7 +233,7 @@ class Qgs2DPlot : QgsPlot
Base class for 2-dimensional plot/chart/graphs.
The base class is responsible for rendering the axis, grid lines and chart area. Subclasses
can implement the :py:func:`~QgsPlotAxis.renderContent` method to render their actual plot content.
can implement the :py:func:`~renderContent` method to render their actual plot content.
.. warning::

4
python/PyQt6/core/auto_generated/processing/qgsprocessingalgorithm.sip.in
View File

@ -443,7 +443,6 @@ Note that some combinations of parameter types and values cannot be represented
:return: - equivalent qgis_process command
- ok: will be set to ``True`` if the command was successfully generated
.. versionadded:: 3.24
%End
@ -779,7 +778,6 @@ a conversion in this case and will return the target layer name in the ``layerNa
: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)
.. seealso:: :py:func:`parameterAsCompatibleSourceLayerPath`
.. versionadded:: 3.10
@ -1127,7 +1125,7 @@ should correspond to the sink parameter name.
class QgsProcessingFeatureBasedAlgorithm : QgsProcessingAlgorithm
{
%Docstring(signature="appended")
An abstract QgsProcessingAlgorithm base class for processing algorithms which operate "feature-by-feature".
An abstract :py:class:`QgsProcessingAlgorithm` base class for processing algorithms which operate "feature-by-feature".
Feature based algorithms are algorithms which operate on individual features in isolation. These
are algorithms where one feature is output for each input feature, and the output feature result

2
python/PyQt6/core/auto_generated/processing/qgsprocessingoutputs.sip.in
View File

@ -135,7 +135,6 @@ Returns a string version of the parameter output ``value`` (if possible).
.. seealso:: :py:func:`valueAsFormattedString`
.. versionadded:: 3.36
%End
@ -153,7 +152,6 @@ By default this will return the same value as :py:func:`~QgsProcessingOutputDefi
.. seealso:: :py:func:`valueAsString`
.. versionadded:: 3.36
%End

8
python/PyQt6/core/auto_generated/processing/qgsprocessingparameters.sip.in
View File

@ -804,7 +804,7 @@ A collection of utilities for working with parameters when running a processing
Parameters are stored in a QVariantMap and referenced by a unique string key.
The QVariants in parameters are not usually accessed
directly, and instead the high level API provided through :py:class:`QgsProcessingParameters`
:py:func:`~QgsProcessingParameterDefinition.parameterAsString`, :py:func:`~QgsProcessingParameterDefinition.parameterAsDouble` are used instead.
:py:func:`~parameterAsString`, :py:func:`~parameterAsDouble` are used instead.
Parameters are evaluated using a provided :py:class:`QgsProcessingContext`, allowing
the evaluation to understand available map layers and expression contexts
@ -1142,7 +1142,6 @@ a conversion in this case and will return the target layer name in the ``layerNa
: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)
.. seealso:: :py:func:`parameterAsCompatibleSourceLayerPath`
.. versionadded:: 3.10
@ -2206,7 +2205,7 @@ class QgsProcessingParameterNumber : QgsProcessingParameterDefinition
%Docstring(signature="appended")
A numeric parameter for processing algorithms.
For numeric parameters with a :py:func:`~QgsProcessingParameterMultipleLayers.dataType` of Double, the number of decimals places
For numeric parameters with a :py:func:`~dataType` of Double, the number of decimals places
shown in the parameter's widget can be specified by setting the parameter's metadata. For example:
.. code-block:: python
@ -3508,7 +3507,6 @@ calls :py:func:`QgsProcessingProvider.isSupportedOutputValue()` to test compatib
:return: - ``True`` if ``value`` is supported.
- error: will be set to a descriptive error string
.. versionadded:: 3.14
%End
@ -3664,7 +3662,7 @@ created by the algorithm.
.. note::
Consider using the more flexible QgsProcessingParameterFeatureSink wherever
Consider using the more flexible :py:class:`QgsProcessingParameterFeatureSink` wherever
possible.
%End

1
python/PyQt6/core/auto_generated/processing/qgsprocessingutils.sip.in
View File

@ -509,7 +509,6 @@ a conversion in this case and will return the target layer name in the ``layerNa
:return: path to source layer, or nearly converted compatible layer
.. seealso:: :py:func:`convertToCompatibleFormat`
.. versionadded:: 3.10

18
python/PyQt6/core/auto_generated/proj/qgscoordinatereferencesystem.sip.in
View File

@ -57,13 +57,11 @@ For example, the following code will create and inspect "British national grid"
This will produce the following output:
.. code-block:: raw
CRS Description: OSGB 1936 / British National Grid
CRS PROJ text: +proj=tmerc +lat_0=49 +lon_0=-2 +k=0.9996012717 +x_0=400000 +y_0=-100000 [output trimmed]
CRS Definition Formats
----------------------
@ -82,7 +80,6 @@ QGIS adds support for "USER" authority that refers to IDs used internally in QGI
is best avoided or used with caution as the IDs are not permanent and they refer to different CRS
on different machines or user profiles.
.. seealso:: :py:func:`authid`
.. seealso:: :py:func:`createFromOgcWmsCrs`
@ -91,13 +88,10 @@ on different machines or user profiles.
format: `+param1=value1 +param2=value2 [...]`. This is the format natively used by the
underlying proj library. For example, the definition of WGS84 looks like this:
.. code-block:: raw
+proj=longlat +datum=WGS84 +no_defs
.. seealso:: :py:func:`toProj`
.. seealso:: :py:func:`createFromProj`
@ -105,7 +99,6 @@ on different machines or user profiles.
- Well-known text (WKT): Defined by Open Geospatial Consortium (OGC), this is another common
format to define CRS. For WGS84 the OGC WKT definition is the following:
.. code-block:: raw
GEOGCS["WGS 84",
@ -116,8 +109,6 @@ on different machines or user profiles.
UNIT["degree",0.0174532925199433,AUTHORITY["EPSG","9122"]],
AUTHORITY["EPSG","4326"]]
.. seealso:: :py:func:`toWkt`
.. seealso:: :py:func:`createFromWkt`
@ -170,7 +161,6 @@ There are two different flavors of WKT: one is defined by OGC, the other is the
used by ESRI. They look very similar, but they are not the same. QGIS is able to consume
both flavors.
.. seealso:: :py:class:`QgsCoordinateTransform`
%End
@ -333,7 +323,6 @@ or the compound CRS could not be created for the combination.
: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
.. versionadded:: 3.38
%End
@ -810,10 +799,8 @@ be returned.
This method requires PROJ 8.0 or later
:raises QgsNotSupportedException: on QGIS builds based on PROJ 7 or earlier.
.. versionadded:: 3.20
%End
@ -827,7 +814,6 @@ Attempts to retrieve the name of the celestial body associated with the CRS (e.g
:raises QgsNotSupportedException: on QGIS builds based on PROJ 8.0 or earlier.
.. versionadded:: 3.20
%End
@ -853,10 +839,8 @@ CRS (see :py:func:`~QgsCoordinateReferenceSystem.isDynamic`).
between a static and dynamic CRS based on either the source or destination CRS coordinate epoch,
however dynamic CRS to dynamic CRS transformations are not currently supported.
.. seealso:: :py:func:`coordinateEpoch`
.. versionadded:: 3.20
%End
@ -882,10 +866,8 @@ CRS (see :py:func:`~QgsCoordinateReferenceSystem.isDynamic`).
:return: Coordinate epoch as decimal year (e.g. 2021.3), or NaN if not set, or relevant.
.. seealso:: :py:func:`setCoordinateEpoch`
.. versionadded:: 3.20
%End

1
python/PyQt6/core/auto_generated/proj/qgscoordinatereferencesystemregistry.sip.in
View File

@ -134,7 +134,6 @@ Returns a list of all known celestial bodies.
:raises QgsNotSupportedException: on QGIS builds based on PROJ 8.0 or earlier.
.. versionadded:: 3.20
%End

8
python/PyQt6/core/auto_generated/proj/qgscoordinatetransform.sip.in
View File

@ -76,7 +76,7 @@ which dictate the behavior of the transformation.
.. warning::
Do NOT use an empty/default constructed QgsCoordinateTransformContext()
Do NOT use an empty/default constructed :py:class:`QgsCoordinateTransformContext`()
object when creating QgsCoordinateTransform objects. This prevents correct
datum transform handling and may result in inaccurate transformations. Always
ensure that the :py:class:`QgsCoordinateTransformContext` object is correctly retrieved
@ -109,7 +109,6 @@ correctly respected during coordinate transforms. E.g.
Since QGIS 3.26 the optional ``flags`` argument can be used to specify flags
which dictate the behavior of the transformation.
.. warning::
Since QGIS 3.20 The QgsCoordinateTransform class can perform time-dependent transformations
@ -372,7 +371,6 @@ coordinates.
Requires Proj 6.0 or later. Builds based on earlier Proj versions will always return
an empty string, and the deprecated :py:func:`~QgsCoordinateTransform.sourceDatumTransformId` or :py:func:`~QgsCoordinateTransform.destinationDatumTransformId` methods should be used instead.
.. seealso:: :py:func:`instantiatedCoordinateOperationDetails`
.. seealso:: :py:func:`setCoordinateOperation`
@ -413,7 +411,6 @@ coordinates.
Requires Proj 6.0 or later. Builds based on earlier Proj versions will ignore this setting,
and the deprecated :py:func:`~QgsCoordinateTransform.setSourceDatumTransformId` or :py:func:`~QgsCoordinateTransform.setDestinationDatumTransformId` methods should be used instead.
.. seealso:: :py:func:`coordinateOperation`
.. versionadded:: 3.8
@ -434,7 +431,6 @@ are transformed). See :py:func:`~QgsCoordinateTransform.fallbackOperationOccurre
If :py:func:`~QgsCoordinateTransform.setBallparkTransformsAreAppropriate` is set to ``True``, this setting will be ignored
and fallback transformations will always be permitted.
.. seealso:: :py:func:`allowFallbackTransforms`
.. seealso:: :py:func:`setBallparkTransformsAreAppropriate`
@ -493,7 +489,6 @@ and fallback transforms will always be allowed when required.
Requires Proj 6.0 or later. Builds based on earlier Proj versions will ignore this setting.
.. versionadded:: 3.12
%End
@ -513,7 +508,6 @@ operation occurred by testing :py:func:`~QgsCoordinateTransform.fallbackOperatio
Requires Proj 6.0 or later. Builds based on earlier Proj versions will never perform fallback operations.
.. seealso:: :py:func:`fallbackOperationOccurred`
.. versionadded:: 3.12

8
python/PyQt6/core/auto_generated/proj/qgscoordinatetransformcontext.sip.in
View File

@ -29,7 +29,6 @@ system.
:py:class:`QgsCoordinateTransformContext` objects are implicitly shared.
.. seealso:: :py:class:`QgsDatumTransform`
.. seealso:: :py:class:`QgsCoordinateTransform`
@ -72,7 +71,6 @@ required for transformations for that source or destination.
.. seealso:: :py:func:`addSourceDestinationDatumTransform`
.. deprecated::
Has no effect on builds based on Proj 6.0 or later, use :py:func:`~QgsCoordinateTransformContext.coordinateOperations` instead.
%End
@ -90,13 +88,11 @@ Returns the stored mapping for source to destination CRS pairs to associated coo
.. seealso:: :py:func:`addCoordinateOperation`
.. note::
Requires Proj 6.0 or later. Builds based on earlier Proj versions will always return an empty list,
and the deprecated :py:func:`~QgsCoordinateTransformContext.sourceDestinationDatumTransforms` method must be used instead.
.. versionadded:: 3.8
%End
@ -148,13 +144,11 @@ Returns ``True`` if the new coordinate operation was added successfully.
.. seealso:: :py:func:`removeCoordinateOperation`
.. note::
Requires Proj 6.0 or later. Builds based on earlier Proj versions will ignore this setting,
and the deprecated :py:func:`~QgsCoordinateTransformContext.addSourceDestinationDatumTransform` method must be used instead.
.. versionadded:: 3.8
%End
@ -221,14 +215,12 @@ be used.
Requires Proj 6.0 or later. Builds based on earlier Proj versions will always return
an empty string, and the deprecated :py:func:`~QgsCoordinateTransformContext.calculateDatumTransforms` method should be used instead.
.. warning::
Always check the result of :py:func:`~QgsCoordinateTransformContext.mustReverseCoordinateOperation` in order to determine if the
proj coordinate operation string returned by this method corresponds to the reverse operation, and
must be manually flipped when calculating coordinate transforms.
.. versionadded:: 3.8
%End

2
python/PyQt6/core/auto_generated/proj/qgsellipsoidutils.sip.in
View File

@ -78,10 +78,8 @@ Returns a list of all known celestial bodies.
This method requires PROJ 8.1 or later
:raises QgsNotSupportedException: on QGIS builds based on PROJ 8.0 or earlier.
.. versionadded:: 3.20
%End

15
python/PyQt6/core/auto_generated/project/qgsproject.sip.in
View File

@ -342,7 +342,6 @@ on the returned value to determine the type of CRS returned by this method.
.. seealso:: :py:func:`crs3DChanged`
.. versionadded:: 3.38
%End
@ -408,7 +407,6 @@ The returned CRS will be invalid if the project has no vertical CRS.
.. seealso:: :py:func:`setVerticalCrs`
.. versionadded:: 3.38
%End
@ -426,16 +424,13 @@ 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
.. seealso:: :py:func:`verticalCrs`
.. seealso:: :py:func:`setCrs`
.. versionadded:: 3.38
%End
@ -1197,7 +1192,6 @@ The :py:func:`~QgsProject.legendLayersAdded` signal is emitted only if addToLege
successfully. If a layer or already exists in the registry,
it will not be part of the returned QList.
.. note::
As a side-effect QgsProject is made dirty.
@ -1228,10 +1222,8 @@ If you are adding multiple layers at once, you should use
:return: ``None`` if unable to add layer, otherwise pointer to newly added layer
.. seealso:: :py:func:`addMapLayers`
.. note::
As a side-effect QgsProject is made dirty.
@ -2226,7 +2218,6 @@ be made persistent until :py:func:`~QgsProject.commitChanges` is called, and can
.. seealso:: :py:func:`rollBack`
.. versionadded:: 3.26
%End
@ -2255,12 +2246,10 @@ that the user has some chance of repairing the damage cleanly.
:return: - ``True`` if the commit was successful.
- commitErrors: will be set to a list of descriptive errors if the commit fails.
.. seealso:: :py:func:`startEditing`
.. seealso:: :py:func:`rollBack`
.. versionadded:: 3.26
%End
@ -2276,12 +2265,10 @@ Stops a current editing operation on vectorLayer and discards any uncommitted ed
:return: - ``True`` if the rollback was successful.
- rollbackErrors: will be set to a list of descriptive errors if the rollback fails.
.. seealso:: :py:func:`startEditing`
.. seealso:: :py:func:`commitChanges`
.. versionadded:: 3.26
%End
@ -2290,7 +2277,7 @@ Stops a current editing operation on vectorLayer and discards any uncommitted ed
class QgsProjectDirtyBlocker
{
%Docstring(signature="appended")
Temporarily blocks QgsProject "dirtying" for the lifetime of the object.
Temporarily blocks :py:class:`QgsProject` "dirtying" for the lifetime of the object.
:py:class:`QgsProjectDirtyBlocker` supports "stacked" blocking, so two :py:class:`QgsProjectDirtyBlockers` created
for the same project will both need to be destroyed before the project can be dirtied again.

3
python/PyQt6/core/auto_generated/project/qgsprojectelevationproperties.sip.in
View File

@ -83,7 +83,6 @@ elevation limits associated with the project.
.. seealso:: :py:func:`elevationRangeChanged`
.. versionadded:: 3.38
%End
@ -126,7 +125,6 @@ elevation limits associated with the project.
.. seealso:: :py:func:`elevationRangeChanged`
.. versionadded:: 3.38
%End
@ -173,7 +171,6 @@ Emitted when the project's elevation ``is`` changed.
.. seealso:: :py:func:`setElevationRange`
.. versionadded:: 3.38
%End

6
python/PyQt6/core/auto_generated/project/qgsprojectproperty.sip.in
View File

@ -148,14 +148,14 @@ Project property key node.
Can, itself, contain :py:class:`QgsProjectPropertyKey` and :py:class:`QgsProjectPropertyValues`.
The internal QHash, mProperties, maps key names to their respective
QgsProjectPropertyValue or next QgsProjectPropertyKey in the key name sequence. The key with
the current name should contain its QgsProjectPropertyValue.
:py:class:`QgsProjectPropertyValue` or next :py:class:`QgsProjectPropertyKey` in the key name sequence. The key with
the current name should contain its :py:class:`QgsProjectPropertyValue`.
E.g., given the key sequence "/foo/bar", "foo" will have a corresponding
:py:class:`QgsProjectPropertyKey` with a name "foo". It will contain an element in its
mProperties that maps to "bar", which is another :py:class:`QgsProjectPropertyKey`. The "bar"
:py:class:`QgsProjectPropertyKey` will, in turn, have an element that maps to itself, i.e. "bar",
that will contain a QgsProjectPropertyValue.
that will contain a :py:class:`QgsProjectPropertyValue`.
%End
%TypeHeaderCode

2
python/PyQt6/core/auto_generated/project/qgsprojectstylesettings.sip.in
View File

@ -368,7 +368,7 @@ class QgsProjectStyleDatabaseProxyModel : QSortFilterProxyModel
{
%Docstring(signature="appended")
A proxy model for filtering QgsProjectStyleDatabaseModel.
A proxy model for filtering :py:class:`QgsProjectStyleDatabaseModel`.
.. versionadded:: 3.26
%End

2
python/PyQt6/core/auto_generated/project/qgsprojecttimesettings.sip.in
View File

@ -161,7 +161,6 @@ Returns the total number of frames for the project's movie.
.. seealso:: :py:func:`setTotalMovieFrames`
.. versionadded:: 3.36
%End
@ -175,7 +174,6 @@ Sets the total number of ``frames`` for the movie.
.. seealso:: :py:func:`totalMovieFrames`
.. versionadded:: 3.36
%End

1
python/PyQt6/core/auto_generated/providers/qgsabstractdatabaseproviderconnection.sip.in
View File

@ -563,7 +563,6 @@ Renames an existing field.
it is responsibility of the caller to handle open layers and registry entries.
:raises QgsProviderConnectionException: if any errors are encountered.
.. versionadded:: 3.28

4
python/PyQt6/core/auto_generated/providers/qgsprovidermetadata.sip.in
View File

@ -441,12 +441,10 @@ metadata :py:func:`~QgsProviderMetadata.createDatabase` method can be used to cr
: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.
.. note::
This method is only supported by providers which return the QgsProviderMetadata.ProviderMetadataCapability.CreateDatabase capability.
.. versionadded:: 3.28
%End
@ -678,11 +676,9 @@ Saves ``metadata`` to the layer corresponding to the specified ``uri``.
:return: - ``True`` if the metadata was successfully saved.
- errorMessage: descriptive string of error if encountered
:raises QgsNotSupportedException: if the provider does not support saving layer metadata for the
specified ``uri``.
.. versionadded:: 3.20
%End

5
python/PyQt6/core/auto_generated/providers/qgsproviderregistry.sip.in
View File

@ -313,11 +313,9 @@ Saves ``metadata`` to the layer corresponding to the specified ``uri``.
:return: - ``True`` if the metadata was successfully saved.
- errorMessage: descriptive string of error if encountered
:raises QgsNotSupportedException: if the provider does not support saving layer metadata for the
specified ``uri``.
.. versionadded:: 3.20
%End
@ -522,7 +520,6 @@ handled by any registered providers, and construct user-friendly warnings as to
ownership of the UnusableUriHandlerInterface instance is transferred to the registry
.. versionadded:: 3.18.1
%End
@ -545,11 +542,9 @@ QGIS build.
:param uri: URI to test
:return: - ``True`` if the ``uri`` was matched to a registered QgsProviderRegistry.UnusableUriHandlerInterface.
- details: will be populated with details allowing construction of a user-friendly warning message
.. seealso:: :py:func:`registerUnusableUriHandler`
.. versionadded:: 3.18.1

2
python/PyQt6/core/auto_generated/providers/qgsprovidersublayermodel.sip.in
View File

@ -216,7 +216,7 @@ class QgsProviderSublayerProxyModel: QSortFilterProxyModel
{
%Docstring(signature="appended")
A QSortFilterProxyModel for filtering and sorting a QgsProviderSublayerModel.
A QSortFilterProxyModel for filtering and sorting a :py:class:`QgsProviderSublayerModel`.
.. versionadded:: 3.22
%End

1
python/PyQt6/core/auto_generated/providers/sensorthings/qgssensorthingsutils.sip.in
View File

@ -138,7 +138,6 @@ Returns the cardinality of the relationship between a base entity type and a rel
:return: - relationship cardinality
- valid: will be set to ``True`` if a relationship exists between the entity types, or ``False`` if no relationship exists
.. versionadded:: 3.38
%End

1
python/PyQt6/core/auto_generated/qgsbookmarkmanager.sip.in
View File

@ -192,7 +192,6 @@ Adds a ``bookmark`` to the manager.
: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).
.. seealso:: :py:func:`removeBookmark`
.. seealso:: :py:func:`bookmarkAdded`

2
python/PyQt6/core/auto_generated/qgsbookmarkmodel.sip.in
View File

@ -82,7 +82,7 @@ class QgsBookmarkManagerProxyModel : QSortFilterProxyModel
{
%Docstring(signature="appended")
A QSortFilterProxyModel subclass for sorting the entries in a QgsBookmarkManagerModel.
A QSortFilterProxyModel subclass for sorting the entries in a :py:class:`QgsBookmarkManagerModel`.
.. versionadded:: 3.10
%End

2
python/PyQt6/core/auto_generated/qgsdbquerylog.sip.in
View File

@ -58,7 +58,7 @@ Handles logging of database queries.
:py:class:`QgsDatabaseQueryLog` is not usually directly created, but rather accessed through
:py:func:`QgsApplication.databaseQueryLog()`. Generally, clients should only access the
static :py:func:`~QgsDatabaseQueryLogEntry.log` method to register their queries.
static :py:func:`~log` method to register their queries.
Example
-------

2
python/PyQt6/core/auto_generated/qgsdiagramrenderer.sip.in
View File

@ -293,7 +293,7 @@ class QgsDiagramSettings
Stores the settings for rendering a single diagram.
:py:class:`QgsDiagramSettings` stores the settings related to rendering the individual diagrams themselves, while
QgsDiagramLayerSettings stores settings which control how ALL diagrams within a layer are rendered.
:py:class:`QgsDiagramLayerSettings` stores settings which control how ALL diagrams within a layer are rendered.
%End
%TypeHeaderCode

1
python/PyQt6/core/auto_generated/qgsdistancearea.sip.in
View File

@ -376,7 +376,6 @@ will also be in this same CRS.
.. seealso:: :py:func:`splitGeometryAtAntimeridian`
.. versionadded:: 3.6
%End

6
python/PyQt6/core/auto_generated/qgsfeature.sip.in
View File

@ -366,7 +366,6 @@ Returns the feature's attributes as a map of field name to value.
:raises ValueError: if the field definition is unset or the size of the fields does not match the size of the feature's attributes()
.. seealso:: :py:func:`attributes`
.. seealso:: :py:func:`setAttributes`
@ -417,7 +416,6 @@ The number of provided attributes need to exactly match the number of the featur
the number of the feature's fields then it will not be possible to add this feature to the corresponding data
provider.
.. seealso:: :py:func:`setAttribute`
.. seealso:: :py:func:`attributes`
@ -562,8 +560,6 @@ Alternatively, in Python it is possible to directly `del` an attribute via its i
# will now print [11, NONE]
print(feature.attributes())
:raises KeyError: if the field is not found
.. seealso:: :py:func:`setAttribute`
@ -656,8 +652,6 @@ Example
print(feature.geometry())
# output: <QgsGeometry: LineString (210 41, 301 55)>
.. seealso:: :py:func:`geometry`
.. seealso:: :py:func:`clearGeometry`

1
python/PyQt6/core/auto_generated/qgsfeatureiterator.sip.in
View File

@ -148,7 +148,6 @@ features to ensure that any :py:func:`QgsFeatureRequest.destinationCrs()` set on
:raises QgsCsException: if the rect cannot be transformed from the destination CRS.
.. versionadded:: 3.22
%End

3
python/PyQt6/core/auto_generated/qgsfeaturerequest.sip.in
View File

@ -40,7 +40,6 @@ The options may be chained, e.g.:
Examples:
.. code-block:: python
# fetch all features:
@ -645,7 +644,6 @@ the SubsetOfAttributes flag should be removed from the request.
.. seealso:: :py:func:`setSubsetOfAttributes`
.. versionadded:: 3.4
%End
@ -797,7 +795,6 @@ any destination CRS transform present in the feature request.
.. seealso:: :py:func:`coordinateTransform`
.. versionadded:: 3.40
%End

1
python/PyQt6/core/auto_generated/qgsfileutils.sip.in
View File

@ -175,7 +175,6 @@ desired.
: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
.. versionadded:: 3.22
%End

14
python/PyQt6/core/auto_generated/qgsinterval.sip.in
View File

@ -95,7 +95,7 @@ otherwise it will be calculated using the average year length (31557600 seconds)
Sets the interval duration in years.
Replaces the interval size and changes the original interval unit
and duration, :py:func:`originalDuration` and \see originalUnit().
and duration, :py:func:`originalDuration` and :py:func:`originalDuration`.
Changes the original unit to :py:class:`QgsUnitTypes`.TemporalYears
@ -121,7 +121,7 @@ a month consists of exactly 30 days.
Sets the interval duration in months.
Replaces the interval size and changes the original interval unit
and duration, :py:func:`originalDuration` and \see originalUnit().
and duration, :py:func:`originalDuration` and :py:func:`originalDuration`.
Changes the original unit to :py:class:`QgsUnitTypes`.TemporalMonths
@ -146,7 +146,7 @@ otherwise it will be calculated using the QgsInterval.WEEKS constant.
Sets the interval duration in weeks.
Replaces the interval size and changes the original interval unit
and duration, :py:func:`originalDuration` and \see originalUnit().
and duration, :py:func:`originalDuration` and :py:func:`originalDuration`.
Changes the original unit to :py:class:`QgsUnitTypes`.TemporalWeeks
@ -171,7 +171,7 @@ otherwise it will be calculated using the QgsInterval.DAY constant.
Sets the interval duration in days.
Replaces the interval size and changes the original interval unit
and duration, :py:func:`originalDuration` and \see originalUnit().
and duration, :py:func:`originalDuration` and :py:func:`originalDuration`.
Changes the original unit to :py:class:`QgsUnitTypes`.TemporalDays
@ -196,7 +196,7 @@ otherwise it will be calculated using the QgsInterval.HOUR constant.
Sets the interval duration in hours.
Replaces the interval size and changes the original interval unit
and duration, :py:func:`originalDuration` and \see originalUnit().
and duration, :py:func:`originalDuration` and :py:func:`originalDuration`.
The original unit to :py:class:`QgsUnitTypes`.TemporalHours
@ -221,7 +221,7 @@ otherwise it will be calculated using the QgsInterval.MINUTE constant.
Sets the interval duration in minutes.
Replaces the interval size and changes the original interval unit
and duration, :py:func:`originalDuration` and \see originalUnit().
and duration, :py:func:`originalDuration` and :py:func:`originalDuration`.
Changes the original unit to :py:class:`QgsUnitTypes`.TemporalMinutes
@ -242,7 +242,7 @@ Returns the interval duration in seconds.
Sets the interval duration in seconds.
Replaces the interval size and changes the original interval unit
and duration, :py:func:`originalDuration` and \see originalUnit().
and duration, :py:func:`originalDuration` and :py:func:`originalDuration`.
Changes the original unit to :py:class:`QgsUnitTypes`.TemporalSeconds

1
python/PyQt6/core/auto_generated/qgslayerdefinition.sip.in
View File

@ -81,7 +81,6 @@ Exports the selected layer tree nodes to a QLR file.
:return: - ``True`` if the export was successful
- errorMessage: will be set to any error messages generated during the export
.. versionadded:: 3.22
%End

2
python/PyQt6/core/auto_generated/qgsmaphittest.sip.in
View File

@ -83,7 +83,7 @@ Tests whether a given legend key is visible for a specified layer.
class QgsMapHitTestTask : QgsTask
{
%Docstring(signature="appended")
Executes a QgsMapHitTest in a background thread.
Executes a :py:class:`QgsMapHitTest` in a background thread.
.. versionadded:: 3.32
%End

6
python/PyQt6/core/auto_generated/qgsmaplayer.sip.in
View File

@ -209,7 +209,6 @@ the layer is owned by a :py:class:`QgsProject` or :py:class:`QgsMapLayerStore`).
This method should not be called on layers which already belong to a :py:class:`QgsProject` or :py:class:`QgsMapLayerStore`.
.. seealso:: :py:func:`id`
.. seealso:: :py:func:`idChanged`
@ -848,7 +847,6 @@ The returned CRS will be invalid if the layer has no vertical CRS.
.. seealso:: :py:func:`setVerticalCrs`
.. versionadded:: 3.38
%End
@ -873,7 +871,6 @@ on the returned value to determine the type of CRS returned by this method.
.. seealso:: :py:func:`crs3DChanged`
.. versionadded:: 3.38
%End
@ -905,16 +902,13 @@ 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
.. seealso:: :py:func:`verticalCrs`
.. seealso:: :py:func:`setCrs`
.. versionadded:: 3.38
%End

1
python/PyQt6/core/auto_generated/qgsmaplayerfactory.sip.in
View File

@ -34,7 +34,6 @@ Returns the map layer type corresponding a ``string`` value.
:return: - converted map layer type
- ok: will be set to ``True`` if ``string`` was successfully converted to a map layer type
.. seealso:: :py:func:`typeToString`
%End

4
python/PyQt6/core/auto_generated/qgsmaplayerstore.sip.in
View File

@ -124,12 +124,10 @@ The :py:func:`~QgsMapLayerStore.layersAdded` and :py:func:`~QgsMapLayerStore.lay
but if the validity of the layer has changed from ``False`` to ``True``, the
layer data source is updated to the new one.
:return: a list of the map layers that were added
successfully. If a layer already exists in the store,
it will not be part of the returned list.
.. seealso:: :py:func:`addMapLayer`
%End
@ -147,10 +145,8 @@ If you are adding multiple layers at once, you should use
:return: ``None`` if unable to add layer, otherwise pointer to newly added layer
.. seealso:: :py:func:`addMapLayers`
.. note::
Use :py:func:`~QgsMapLayerStore.addMapLayers` if adding more than one layer at a time.

2
python/PyQt6/core/auto_generated/qgsmessagelog.sip.in
View File

@ -68,7 +68,7 @@ temporarily suppressed.
class QgsMessageLogNotifyBlocker
{
%Docstring(signature="appended")
Temporarily blocks the application QgsMessageLog (see :py:func:`QgsApplication.messageLog()`) from emitting the messageReceived( bool )
Temporarily blocks the application :py:class:`QgsMessageLog` (see :py:func:`QgsApplication.messageLog()`) from emitting the messageReceived( bool )
signal for the lifetime of the object.
Using this blocker allows messages to be logged without causing user interface hints flagging message log

5
python/PyQt6/core/auto_generated/qgspathresolver.sip.in
View File

@ -61,7 +61,6 @@ Example - replace an outdated folder path with a new one:
Example - replace a stored database host with a new one:
.. code-block:: python
def my_processor(path):
@ -69,10 +68,8 @@ Example - replace a stored database host with a new one:
QgsPathResolver.setPathPreprocessor(my_processor)
Example - replace stored database credentials with new ones:
.. code-block:: python
def my_processor(path):
@ -82,8 +79,6 @@ Example - replace stored database credentials with new ones:
QgsPathResolver.setPathPreprocessor(my_processor)
.. versionadded:: 3.10
%End
%MethodCode

2
python/PyQt6/core/auto_generated/qgspropertycollection.sip.in
View File

@ -455,7 +455,7 @@ Convenience method, creates a :py:class:`QgsStaticProperty` and stores it within
class QgsPropertyCollectionStack : QgsAbstractPropertyCollection
{
%Docstring(signature="appended")
An ordered stack of QgsPropertyCollection containers, where collections added later to the stack will take
An ordered stack of :py:class:`QgsPropertyCollection` containers, where collections added later to the stack will take
priority over earlier collections.
%End

2
python/PyQt6/core/auto_generated/qgspropertytransformer.sip.in
View File

@ -306,7 +306,7 @@ This applies any curve transforms which may exist on the transformer.
class QgsGenericNumericTransformer : QgsPropertyTransformer
{
%Docstring(signature="appended")
QgsPropertyTransformer subclass for scaling an input numeric value into an output numeric value.
:py:class:`QgsPropertyTransformer` subclass for scaling an input numeric value into an output numeric value.
%End
%TypeHeaderCode

2
python/PyQt6/core/auto_generated/qgsrange.sip.in
View File

@ -146,7 +146,7 @@ typedef QgsRange<double> QgsRangedoubleBase;
class QgsDoubleRange : QgsRangedoubleBase
{
%Docstring(signature="appended")
QgsRange which stores a range of double values.
:py:class:`QgsRange` which stores a range of double values.
.. seealso:: :py:class:`QgsIntRange`

1
python/PyQt6/core/auto_generated/qgsrendercontext.sip.in
View File

@ -947,7 +947,6 @@ When vector features are rendered, they should be clipped to this geometry.
.. seealso:: :py:func:`setFeatureClipGeometry`
.. versionadded:: 3.16
%End

2
python/PyQt6/core/auto_generated/qgsstringutils.sip.in
View File

@ -87,7 +87,7 @@ Creates a new QgsStringReplacement from an encoded properties map.
class QgsStringReplacementCollection
{
%Docstring(signature="appended")
A collection of string replacements (specified using QgsStringReplacement objects).
A collection of string replacements (specified using :py:class:`QgsStringReplacement` objects).
%End
%TypeHeaderCode

2
python/PyQt6/core/auto_generated/qgstaskmanager.sip.in
View File

@ -306,7 +306,7 @@ QFlags<QgsTask::Flag> operator|(QgsTask::Flag f1, QFlags<QgsTask::Flag> f2);
class QgsTaskManager : QObject
{
%Docstring(signature="appended")
Task manager for managing a set of long-running QgsTask tasks. This class can be created directly,
Task manager for managing a set of long-running :py:class:`QgsTask` tasks. This class can be created directly,
or accessed via :py:func:`QgsApplication.taskManager()`.
%End

3
python/PyQt6/core/auto_generated/qgstemporalnavigationobject.sip.in
View File

@ -218,7 +218,6 @@ Returns the total number of frames for the movie.
.. seealso:: :py:func:`totalMovieFramesChanged`
.. versionadded:: 3.36
%End
@ -234,7 +233,6 @@ Sets the total number of ``frames`` for the movie.
.. seealso:: :py:func:`totalMovieFramesChanged`
.. versionadded:: 3.36
%End
@ -272,7 +270,6 @@ Emitted whenever the total number of ``frames`` in the movie is changed.
.. seealso:: :py:func:`totalMovieFrames`
.. versionadded:: 3.36
%End

1
python/PyQt6/core/auto_generated/qgstemporalutils.sip.in
View File

@ -103,7 +103,6 @@ the number of days in the current month.
:return: The calculated datetime for the frame.
.. versionadded:: 3.18
%End

2
python/PyQt6/core/auto_generated/qgstiles.sip.in
View File

@ -105,7 +105,7 @@ Returns index of the last row in the range
class QgsTileMatrix
{
%Docstring(signature="appended")
Defines a matrix of tiles for a single zoom level: it is defined by its size (width * \brief height)
Defines a matrix of tiles for a single zoom level: it is defined by its size (width * height)
and map extent that it covers.
Please note that we follow the XYZ convention of X/Y axes, i.e. top-left tile has [0,0] coordinate

1
python/PyQt6/core/auto_generated/raster/qgsrasterdataprovider.sip.in
View File

@ -610,7 +610,6 @@ Returns whether provider-level resampling is enabled.
.. seealso:: :py:func:`maxOversampling`
.. versionadded:: 3.16
%End

1
python/PyQt6/core/auto_generated/raster/qgsrasteriterator.sip.in
View File

@ -42,7 +42,6 @@ of the raster covering the specified ``subRegion``.
- subRegionLeft: starting column of left side of sub region
- subRegionTop: starting row of top side of sub region
.. versionadded:: 3.26
%End

4
python/PyQt6/core/auto_generated/raster/qgsrasterlayerelevationproperties.sip.in
View File

@ -117,7 +117,6 @@ Returns the fixed elevation range for the raster.
When a fixed range is set any :py:func:`~QgsRasterLayerElevationProperties.zOffset` and :py:func:`~QgsRasterLayerElevationProperties.zScale` is ignored.
.. seealso:: :py:func:`setFixedRange`
.. versionadded:: 3.38
@ -135,7 +134,6 @@ Sets the fixed elevation ``range`` for the raster.
When a fixed range is set any :py:func:`~QgsRasterLayerElevationProperties.zOffset` and :py:func:`~QgsRasterLayerElevationProperties.zScale` is ignored.
.. seealso:: :py:func:`fixedRange`
.. versionadded:: 3.38
@ -153,7 +151,6 @@ Returns the fixed elevation range for each band.
When a fixed range is set any :py:func:`~QgsRasterLayerElevationProperties.zOffset` and :py:func:`~QgsRasterLayerElevationProperties.zScale` is ignored.
.. seealso:: :py:func:`setFixedRangePerBand`
.. versionadded:: 3.38
@ -171,7 +168,6 @@ Sets the fixed elevation range for each band.
When a fixed range is set any :py:func:`~QgsRasterLayerElevationProperties.zOffset` and :py:func:`~QgsRasterLayerElevationProperties.zScale` is ignored.
.. seealso:: :py:func:`fixedRangePerBand`
.. versionadded:: 3.38

1
python/PyQt6/core/auto_generated/raster/qgsrasterrenderer.sip.in
View File

@ -96,7 +96,6 @@ Returns ``True`` if the band was successfully set, or ``False`` if the band coul
.. seealso:: :py:func:`usesBands`
.. versionadded:: 3.38
%End

2
python/PyQt6/core/auto_generated/raster/qgsrasterresampler.sip.in
View File

@ -71,7 +71,7 @@ class QgsRasterResamplerV2 : QgsRasterResampler
{
%Docstring(signature="appended")
Interface for resampling rasters (V2) (e.g. to have a smoother appearance),
which provides a more efficient interface vs QgsRasterResampler.
which provides a more efficient interface vs :py:class:`QgsRasterResampler`.
.. versionadded:: 3.10.1
%End

4
python/PyQt6/core/auto_generated/symbology/qgsrenderer.sip.in
View File

@ -137,7 +137,6 @@ be followed by a corresponding call to :py:func:`~QgsFeatureRenderer.stopRender`
.. seealso:: :py:func:`stopRender`
.. warning::
This method is not thread safe. Before calling :py:func:`~QgsFeatureRenderer.startRender` in a non-main thread,
@ -361,10 +360,8 @@ the features displayed using that key.
: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
.. seealso:: :py:func:`legendKeys`
.. versionadded:: 3.26
%End
@ -497,7 +494,6 @@ Sets the renderer's property collection, used for data defined overrides.
.. seealso:: :py:func:`dataDefinedProperties`
.. versionadded:: 3.38
%End

3
python/PyQt6/core/auto_generated/symbology/qgsstyle.sip.in
View File

@ -872,7 +872,6 @@ The current :py:func:`~QgsStyle.fileName` will be used if no explicit ``filename
.. seealso:: :py:func:`errorString`
.. deprecated::
This function has no effect.
%End
@ -1256,7 +1255,7 @@ Emitted whenever icon previews for entities in the style must be rebuilt.
class QgsStyleEntityInterface
{
%Docstring(signature="appended")
An interface for entities which can be placed in a QgsStyle database.
An interface for entities which can be placed in a :py:class:`QgsStyle` database.
.. versionadded:: 3.10
%End

1
python/PyQt6/core/auto_generated/symbology/qgssvgcache.sip.in
View File

@ -94,7 +94,6 @@ Returns an SVG drawing as a QPicture.
Appropriate translation to the destination painter based on the picture's boundingRect may need to be applied
if rendering the SVG using the top-left or other reference point is desired.
.. warning::
The ``blocking`` parameter must NEVER be ``True`` from GUI based applications (like the main QGIS

3
python/PyQt6/core/auto_generated/symbology/qgssymbollayer.sip.in
View File

@ -360,7 +360,6 @@ The default implementation does nothing.
.. seealso:: :py:func:`startRender`
.. versionadded:: 3.12
%End
@ -384,7 +383,6 @@ The default implementation does nothing.
.. seealso:: :py:func:`stopRender`
.. versionadded:: 3.12
%End
@ -680,7 +678,6 @@ for mask geometries. Only mask geometries which intersect ``rect`` will be insta
.. seealso:: :py:func:`removeMasks`
.. versionadded:: 3.30
%End

2
python/PyQt6/core/auto_generated/symbology/qgssymbollayerutils.sip.in
View File

@ -169,7 +169,6 @@ Converts a ``value`` to a point.
:return: - converted point
- ok: will be set to ``True`` if value was successfully converted
.. seealso:: :py:func:`decodePoint`
.. seealso:: :py:func:`toSize`
@ -204,7 +203,6 @@ Converts a ``value`` to a size.
:return: - converted size
- ok: will be set to ``True`` if value was successfully converted
.. seealso:: :py:func:`decodeSize`
.. seealso:: :py:func:`toPoint`

1
python/PyQt6/core/auto_generated/textrenderer/qgstextrenderer.sip.in
View File

@ -111,7 +111,6 @@ been calculated.
:param mode: text layout mode. Only :py:class:`Qgis`.TextLayoutMode.Rectangle, :py:class:`Qgis`.TextLayoutMode.RectangleCapHeightBased and :py:class:`Qgis`.TextLayoutMode.RectangleAscentBased are accepted.
:param flags: text rendering flags
.. versionadded:: 3.30
%End

4
python/PyQt6/core/auto_generated/validity/qgsabstractvaliditycheck.sip.in
View File

@ -47,13 +47,13 @@ class QgsAbstractValidityCheck
Abstract base class for individual validity checks.
Validity checks represent objects which can run a test using a :py:class:`QgsValidityCheckContext`, and return
the results of the check via QgsValidityCheckResult objects.
the results of the check via :py:class:`QgsValidityCheckResult` objects.
Checks can be used for many different use cases, e.g. validating a layout's contents before allowing
an export to occur, or validating the contents of a Processing model (and warning if required plugin based
providers are not available or if compulsory algorithm parameters have not been populated).
Subclasses must indicate the type of check they represent via the :py:func:`~QgsValidityCheckResult.checkType` method. When checks are performed,
Subclasses must indicate the type of check they represent via the :py:func:`~checkType` method. When checks are performed,
all the registered checks with a matching check type are performed sequentially. The check type also
dictates the subclass of the :py:class:`QgsValidityCheckContext` which is given to the subclass' runCheck method.

15
python/PyQt6/core/auto_generated/vector/qgsvectorlayer.sip.in
View File

@ -75,13 +75,10 @@ Since QGIS 3.4 when closing a project, the application shows a warning about pot
loss if there are any non-empty memory layers present. If your memory layer should not
trigger such warning, it is possible to suppress that by setting the following custom variable:
.. code-block:: python
layer.setCustomProperty("skipMemoryLayersCheck", 1)
OGR data provider (ogr)
~~~~~~~~~~~~~~~~~~~~~~~
@ -331,7 +328,6 @@ Grass data provider (grass)
Provider to display vector data in a GRASS GIS layer.
.. seealso:: :py:class:`QgsVectorLayerUtils`
%End
@ -726,7 +722,6 @@ Returns a copy of the user-selected features.
:return: A list of :py:class:`QgsFeature`
.. seealso:: :py:func:`selectedFeatureIds`
.. seealso:: :py:func:`getSelectedFeatures`
@ -741,14 +736,12 @@ Returns an iterator of the selected features.
:return: Iterator over the selected features
.. warning::
Calling this method returns an iterator for all attributes and geometry for the selected features.
Consider using the much more efficient :py:func:`~QgsVectorLayer.selectedFeatureIds` or :py:func:`~QgsVectorLayer.selectedFeatureCount` if you do not
require access to the feature attributes or geometry.
.. seealso:: :py:func:`selectedFeatureIds`
.. seealso:: :py:func:`selectedFeatures`
@ -1096,7 +1089,6 @@ Returns ``True`` if the feature's attribute was successfully changed.
can be slow to execute. Consider using the more efficient :py:func:`~QgsVectorLayer.changeAttributeValue` or
:py:func:`~QgsVectorLayer.changeGeometry` methods instead.
.. seealso:: :py:func:`startEditing`
.. seealso:: :py:func:`commitChanges`
@ -1764,7 +1756,6 @@ be updated. This can be used to override default field value expressions.
to the underlying data provider until a :py:func:`~QgsVectorLayer.commitChanges` call is made. Any uncommitted
changes can be discarded by calling :py:func:`~QgsVectorLayer.rollBack`.
.. seealso:: :py:func:`startEditing`
.. seealso:: :py:func:`commitChanges`
@ -1804,7 +1795,6 @@ If ``context`` is provided, it will be used when updating default values (since
to the underlying data provider until a :py:func:`~QgsVectorLayer.commitChanges` call is made. Any uncommitted
changes can be discarded by calling :py:func:`~QgsVectorLayer.rollBack`.
.. seealso:: :py:func:`startEditing`
.. seealso:: :py:func:`commitChanges`
@ -1846,7 +1836,6 @@ If ``context`` is provided, it will be used when updating default values (since
provider until a :py:func:`~QgsVectorLayer.commitChanges` call is made. Any uncommitted changes
can be discarded by calling :py:func:`~QgsVectorLayer.rollBack`.
.. seealso:: :py:func:`startEditing`
.. seealso:: :py:func:`commitChanges`
@ -2353,7 +2342,6 @@ Returns the minimum value for an attribute column or an invalid variant in case
If both the minimum and maximum value are required it is more efficient to call :py:func:`~QgsVectorLayer.minimumAndMaximumValue`
instead of separate calls to :py:func:`~QgsVectorLayer.minimumValue` and :py:func:`~QgsVectorLayer.maximumValue`.
.. seealso:: :py:func:`maximumValue`
.. seealso:: :py:func:`minimumAndMaximumValue`
@ -2377,7 +2365,6 @@ Returns the maximum value for an attribute column or an invalid variant in case
If both the minimum and maximum value are required it is more efficient to call :py:func:`~QgsVectorLayer.minimumAndMaximumValue`
instead of separate calls to :py:func:`~QgsVectorLayer.minimumValue` and :py:func:`~QgsVectorLayer.maximumValue`.
.. seealso:: :py:func:`minimumValue`
.. seealso:: :py:func:`minimumAndMaximumValue`
@ -2401,12 +2388,10 @@ and maximum values are required.
calculated values may be outdated (for instance when the attribute value in a saved feature has
been changed inside the edit buffer then the previous saved value may be returned as the maximum).
.. seealso:: :py:func:`minimumValue`
.. 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.

5
python/PyQt6/core/auto_generated/vectortile/qgsmapboxglstyleconverter.sip.in
View File

@ -311,8 +311,8 @@ class QgsMapBoxGlStyleConverter
Handles conversion of MapBox GL styles to QGIS vector tile renderers and labeling
settings.
Conversions are performed by calling :py:func:`~QgsMapBoxGlStyleRasterSubLayer.convert` with either a JSON map or JSON
string value, and then retrieving the results by calling :py:func:`~QgsMapBoxGlStyleRasterSubLayer.renderer` or :py:func:`~QgsMapBoxGlStyleRasterSubLayer.labeling`
Conversions are performed by calling :py:func:`~convert` with either a JSON map or JSON
string value, and then retrieving the results by calling :py:func:`~renderer` or :py:func:`~labeling`
respectively.
.. versionadded:: 3.16
@ -535,7 +535,6 @@ Parses a symbol layer as a renderer
:param jsonLayer: fill layer to parse
:param context: conversion context
:return: - ``True`` if symbol layer was converted to renderer
- rendererStyle: generated QGIS vector tile style
%End

6
python/PyQt6/core/auto_generated/vectortile/qgsvectortilerenderer.sip.in
View File

@ -95,9 +95,9 @@ Abstract base class for all vector tile renderer implementations.
For rendering it is expected that client code calls:
# :py:func:`~QgsVectorTileRendererData.startRender` to prepare renderer
# :py:func:`~QgsVectorTileRendererData.renderTile` for each tile
# :py:func:`~QgsVectorTileRendererData.stopRender` to clean up renderer and free resources
# :py:func:`~startRender` to prepare renderer
# :py:func:`~renderTile` for each tile
# :py:func:`~stopRender` to clean up renderer and free resources
.. versionadded:: 3.14
%End

2
python/PyQt6/core/auto_generated/web/qgswebenginepage.sip.in
View File

@ -66,7 +66,6 @@ If ``blocking`` is ``True`` then the call will block while the HTML is loaded. O
Setting ``blocking`` to ``True`` involves running the event loop on the current thread. Take care when calling from the main thread as incorrect use will result in crashes.
:return: ``True`` if loading was successful
%End
@ -110,7 +109,6 @@ The ``painterRect`` argument specifies the target rectangle for the page in ``pa
:return: ``True`` if rendering was successful
:raises QgsNotSupportedException: on QGIS builds without PDF4Qt library support.
%End

4
python/PyQt6/gui/auto_generated/annotations/qgscreateannotationitemmaptool.sip.in
View File

@ -73,8 +73,8 @@ class QgsCreateAnnotationItemMapToolInterface
An interface for map tools which create annotation items.
Clients should connect to the map tool's :py:func:`~QgsCreateAnnotationItemMapToolHandler.itemCreated` signal, and call the
:py:func:`~QgsCreateAnnotationItemMapToolHandler.takeCreatedItem` implementation to take ownership of the newly created item
Clients should connect to the map tool's :py:func:`~itemCreated` signal, and call the
:py:func:`~takeCreatedItem` implementation to take ownership of the newly created item
whenever this signal is emitted.
.. versionadded:: 3.22

1
python/PyQt6/gui/auto_generated/editorwidgets/core/qgseditorwidgetwrapper.sip.in
View File

@ -287,7 +287,6 @@ to reflect the new value.
:param value: The new value of the attribute
.. deprecated:: QGIS 3.10
%End
void setValues( const QVariant &value, const QVariantList &additionalValues );

6
python/PyQt6/gui/auto_generated/editorwidgets/qgsdatetimeedit.sip.in
View File

@ -188,14 +188,13 @@ The :py:class:`QgsTimeEdit` class is a QTimeEdit widget with the capability of s
You should use the signal timeValueChanged of this subclass
rather than QDateTimeEdit.timeChanged. (If you consequently connect parent's
timeChanged signal and call :py:func:`~QgsDateTimeEdit.time` afterwards there is no guarantee that
timeChanged signal and call :py:func:`~time` afterwards there is no guarantee that
NULL values will be correctly handled).
.. seealso:: :py:class:`QgsDateTimeEdit`
.. seealso:: :py:class:`QgsDateEdit`
.. versionadded:: 3.14
%End
@ -243,14 +242,13 @@ The :py:class:`QgsDateEdit` class is a QDateEdit widget with the capability of s
You should use the signal dateValueChanged of this subclass
rather than QDateTimeEdit.dateChanged. (If you consequently connect parent's
dateChanged signal and call :py:func:`~QgsTimeEdit.date` afterwards there is no guarantee that
dateChanged signal and call :py:func:`~date` afterwards there is no guarantee that
NULL values will be correctly handled).
.. seealso:: :py:class:`QgsDateTimeEdit`
.. seealso:: :py:class:`QgsTimeEdit`
.. versionadded:: 3.14
%End

1
python/PyQt6/gui/auto_generated/history/qgshistoryproviderregistry.sip.in
View File

@ -113,7 +113,6 @@ Adds an ``entry`` to the history logs.
:return: - ID of newly added entry.
- ok: will be set to ``True`` if entry was successfully added
.. seealso:: :py:func:`entryAdded`
%End

Some files were not shown because too many files have changed in this diff Show More