Skip to content

Commit

Permalink
Fix more function links
Browse files Browse the repository at this point in the history
  • Loading branch information
nyalldawson committed Dec 2, 2024
1 parent 0cf0d49 commit 8ec6807
Show file tree
Hide file tree
Showing 60 changed files with 95 additions and 94 deletions.
2 changes: 1 addition & 1 deletion python/PyQt6/core/auto_additions/qgscadutils.py
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@
except NameError:
pass
try:
QgsCadUtils.AlignMapPointOutput.__attribute_docs__ = {'valid': 'Whether the combination of constraints is actually valid', 'finalMapPoint': 'map point aligned according to the constraints', 'snapMatch': 'Snapped point - only valid if actually used for something\n\n.. versionadded:: 3.14', 'edgeMatch': 'Snapped segment - only valid if actually used for something\n\n.. deprecated:: 3.40\n\n Will be removed in QGIS 4.0 - use snapMatch instead.', 'softLockCommonAngle': 'Angle (in degrees) to which we have soft-locked ourselves (if not set it is -1)'}
QgsCadUtils.AlignMapPointOutput.__attribute_docs__ = {'valid': 'Whether the combination of constraints is actually valid', 'finalMapPoint': 'map point aligned according to the constraints', 'snapMatch': 'Snapped point - only valid if actually used for something\n\n.. versionadded:: 3.14', 'edgeMatch': 'Snapped segment - only valid if actually used for something\n\n.. deprecated:: 3.40\n\n Will be removed in QGIS 4.0 - use :py:func:`~AlignMapPointOutput.snapMatch` instead.', 'softLockCommonAngle': 'Angle (in degrees) to which we have soft-locked ourselves (if not set it is -1)'}
except NameError:
pass
try:
Expand Down
2 changes: 1 addition & 1 deletion python/PyQt6/core/auto_additions/qgsgpsinformation.py
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
# The following has been generated automatically from src/core/gps/qgsgpsinformation.h
try:
QgsGpsInformation.__attribute_docs__ = {'latitude': 'Latitude in decimal degrees, using the WGS84 datum. A positive value indicates the Northern Hemisphere, and\na negative value indicates the Southern Hemisphere.', 'longitude': 'Longitude in decimal degrees, using the WGS84 datum. A positive value indicates the Eastern Hemisphere, and\na negative value indicates the Western Hemisphere.', 'elevation': 'Altitude (in meters) above or below the mean sea level.', 'elevation_diff': 'Geoidal separation (in meters).\n\nThe difference between the WGS-84 Earth ellipsoid and the mean sea level (geoid).\n\nNegative values indicate that mean sea level is below the ellipsoid.\n\nThis value can be added to the elevation value to obtain the geoidal elevation.\n\n.. versionadded:: 3.18', 'speed': 'Ground speed, in km/h.', 'direction': 'The bearing measured in degrees clockwise from true north to the direction of travel.', 'satellitesInView': 'Contains a list of information relating to the current satellites in view.', 'pdop': 'Dilution of precision.', 'hdop': 'Horizontal dilution of precision.', 'vdop': 'Vertical dilution of precision.', 'hvacc': '3D RMS\n\n.. versionadded:: 3.18', 'utcTime': 'The time at which this position was reported, in UTC time.\n\n.. versionadded:: 3.30', 'utcDateTime': 'The date and time at which this position was reported, in UTC time.', 'fixMode': 'Fix mode (where M = Manual, forced to operate in 2D or 3D or A = Automatic, 3D/2D)', 'fixType': 'Contains the fix type, where 1 = no fix, 2 = 2d fix, 3 = 3d fix\n\n.. deprecated:: 3.40\n\n Use :py:func:`~QgsGpsInformation.constellationFixStatus` or :py:func:`~QgsGpsInformation.bestFixStatus` instead.', 'quality': 'GPS quality indicator (0 = Invalid; 1 = Fix; 2 = Differential, 3 = Sensitive, etc.)\n\n.. deprecated:: 3.40\n\n Use qualityIndicator instead.', 'qualityIndicator': 'Returns the signal quality indicator\n\n.. versionadded:: 3.22.6', 'satellitesUsed': 'Count of satellites used in obtaining the fix.', 'status': 'Status (A = active or V = void)', 'satPrn': 'IDs of satellites used in the position fix.', 'satInfoComplete': '``True`` if satellite information is complete.'}
QgsGpsInformation.__attribute_docs__ = {'latitude': 'Latitude in decimal degrees, using the WGS84 datum. A positive value indicates the Northern Hemisphere, and\na negative value indicates the Southern Hemisphere.', 'longitude': 'Longitude in decimal degrees, using the WGS84 datum. A positive value indicates the Eastern Hemisphere, and\na negative value indicates the Western Hemisphere.', 'elevation': 'Altitude (in meters) above or below the mean sea level.', 'elevation_diff': 'Geoidal separation (in meters).\n\nThe difference between the WGS-84 Earth ellipsoid and the mean sea level (geoid).\n\nNegative values indicate that mean sea level is below the ellipsoid.\n\nThis value can be added to the elevation value to obtain the geoidal elevation.\n\n.. versionadded:: 3.18', 'speed': 'Ground speed, in km/h.', 'direction': 'The bearing measured in degrees clockwise from true north to the direction of travel.', 'satellitesInView': 'Contains a list of information relating to the current satellites in view.', 'pdop': 'Dilution of precision.', 'hdop': 'Horizontal dilution of precision.', 'vdop': 'Vertical dilution of precision.', 'hvacc': '3D RMS\n\n.. versionadded:: 3.18', 'utcTime': 'The time at which this position was reported, in UTC time.\n\n.. versionadded:: 3.30', 'utcDateTime': 'The date and time at which this position was reported, in UTC time.', 'fixMode': 'Fix mode (where M = Manual, forced to operate in 2D or 3D or A = Automatic, 3D/2D)', 'fixType': 'Contains the fix type, where 1 = no fix, 2 = 2d fix, 3 = 3d fix\n\n.. deprecated:: 3.40\n\n Use :py:func:`~QgsGpsInformation.constellationFixStatus` or :py:func:`~QgsGpsInformation.bestFixStatus` instead.', 'quality': 'GPS quality indicator (0 = Invalid; 1 = Fix; 2 = Differential, 3 = Sensitive, etc.)\n\n.. deprecated:: 3.40\n\n Use :py:func:`~QgsGpsInformation.qualityIndicator` instead.', 'qualityIndicator': 'Returns the signal quality indicator\n\n.. versionadded:: 3.22.6', 'satellitesUsed': 'Count of satellites used in obtaining the fix.', 'status': 'Status (A = active or V = void)', 'satPrn': 'IDs of satellites used in the position fix.', 'satInfoComplete': '``True`` if satellite information is complete.'}
QgsGpsInformation.__group__ = ['gps']
except NameError:
pass
Original file line number Diff line number Diff line change
Expand Up @@ -292,7 +292,7 @@ Sets the capabilities for the data item.

.. deprecated:: 3.40

Use setCapabilitiesV2 instead.
Use :py:func:`~QgsDataItem.setCapabilitiesV2` instead.
%End


Expand Down
4 changes: 2 additions & 2 deletions python/PyQt6/core/auto_generated/geometry/qgscircle.sip.in
Original file line number Diff line number Diff line change
Expand Up @@ -301,7 +301,7 @@ Returns the number of tangents (either 0 or 2).
virtual void setSemiMajorAxis( double semiMajorAxis ) /HoldGIL/;

%Docstring
Inherited method. Use setRadius instead.
Inherited method. Use :py:func:`~QgsCircle.setRadius` instead.

.. seealso:: :py:func:`radius`

Expand All @@ -311,7 +311,7 @@ Inherited method. Use setRadius instead.
virtual void setSemiMinorAxis( double semiMinorAxis ) /HoldGIL/;

%Docstring
Inherited method. Use setRadius instead.
Inherited method. Use :py:func:`~QgsCircle.setRadius` instead.

.. seealso:: :py:func:`radius`

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -857,13 +857,14 @@ corresponds to the last point in the line.
QgsBox3D calculateBoundingBox3d() const /Deprecated/;
%Docstring
Calculates the minimal 3D bounding box for the geometry.
Deprecated: use calculateBoundingBox3D instead

.. seealso:: :py:func:`calculateBoundingBox`

.. versionadded:: 3.26

.. deprecated:: 3.34

use :py:func:`~QgsLineString.calculateBoundingBox3D` instead
%End

virtual QgsBox3D calculateBoundingBox3D() const;
Expand Down
4 changes: 2 additions & 2 deletions python/PyQt6/core/auto_generated/project/qgsproject.sip.in
Original file line number Diff line number Diff line change
Expand Up @@ -969,7 +969,7 @@ transaction.

.. deprecated:: 3.26

Use transactionMode instead.
Use :py:func:`~QgsProject.transactionMode` instead.
%End

void setAutoTransaction( bool autoTransaction ) /Deprecated/;
Expand All @@ -984,7 +984,7 @@ transaction.

.. deprecated:: 3.26

Use setTransactionMode instead.
Use :py:func:`~QgsProject.setTransactionMode` instead.
%End

Qgis::TransactionMode transactionMode() const;
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -33,7 +33,7 @@ If there are several identifier fields defined, the behavior is not guaranteed

.. deprecated:: 3.10

Use identifierFields instead.
Use :py:func:`~QgsFeatureFilterModel.identifierFields` instead.
%End

QStringList identifierFields() const;
Expand Down
2 changes: 1 addition & 1 deletion python/PyQt6/core/auto_generated/qgsmaptopixel.sip.in
Original file line number Diff line number Diff line change
Expand Up @@ -137,7 +137,7 @@ Transforms device coordinates to map (world) coordinates.

.. deprecated:: 3.4

Use toMapCoordinates instead.
Use :py:func:`~QgsMapToPixel.toMapCoordinates` instead.
%End

void setMapUnitsPerPixel( double mapUnitsPerPixel );
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -485,7 +485,7 @@ Writes a layer out to a vector file.

.. deprecated:: 3.20

Use writeAsVectorFormatV3 instead.
Use :py:func:`~QgsVectorFileWriter.writeAsVectorFormatV3` instead.
%End

static QgsVectorFileWriter::WriterError writeAsVectorFormatV3( QgsVectorLayer *layer,
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -252,7 +252,7 @@ Returns settings value with an optional default value override

.. deprecated:: 3.26

Use valueAsVariantWithDefaultOverride instead.
Use :py:func:`~QgsSettingsEntryBase.valueAsVariantWithDefaultOverride` instead.
%End

QVariant valueAsVariant( const QStringList &dynamicKeyPartList, bool useDefaultValueOverride, const QVariant &defaultValueOverride ) const /Deprecated/;
Expand All @@ -261,7 +261,7 @@ Returns settings value with an optional default value override

.. deprecated:: 3.26

Use valueAsVariantWithDefaultOverride instead.
Use :py:func:`~QgsSettingsEntryBase.valueAsVariantWithDefaultOverride` instead.
%End


Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -156,14 +156,14 @@ This will take ownership of the method

.. deprecated:: 3.10

Use classficationMethod instead.
Use :py:func:`~QgsGraduatedSymbolRenderer.classficationMethod` instead.
%End
void setMode( Mode mode ) /Deprecated/;
%Docstring

.. deprecated:: 3.10

Use classficationMethod instead.
Use :py:func:`~QgsGraduatedSymbolRenderer.classficationMethod` instead.
%End

bool useSymmetricMode() const /Deprecated/;
Expand All @@ -174,7 +174,7 @@ Returns if we want to classify symmetric around a given value

.. deprecated:: 3.10

Use classficationMethod instead.
Use :py:func:`~QgsGraduatedSymbolRenderer.classficationMethod` instead.
%End

void setUseSymmetricMode( bool useSymmetricMode ) /Deprecated/;
Expand All @@ -185,7 +185,7 @@ Set if we want to classify symmetric around a given value

.. deprecated:: 3.10

Use classficationMethod instead.
Use :py:func:`~QgsGraduatedSymbolRenderer.classficationMethod` instead.
%End

double symmetryPoint() const /Deprecated/;
Expand All @@ -196,7 +196,7 @@ Returns the pivot value for symmetric classification

.. deprecated:: 3.10

Use classficationMethod instead.
Use :py:func:`~QgsGraduatedSymbolRenderer.classficationMethod` instead.
%End

void setSymmetryPoint( double symmetryPoint ) /Deprecated/;
Expand All @@ -207,7 +207,7 @@ Set the pivot point

.. deprecated:: 3.10

Use classficationMethod instead.
Use :py:func:`~QgsGraduatedSymbolRenderer.classficationMethod` instead.
%End


Expand All @@ -219,7 +219,7 @@ Returns if we want to have a central class astride the pivot value

.. deprecated:: 3.10

Use classficationMethod instead.
Use :py:func:`~QgsGraduatedSymbolRenderer.classficationMethod` instead.
%End

void setAstride( bool astride ) /Deprecated/;
Expand All @@ -230,7 +230,7 @@ Set if we want a central class astride the pivot value

.. deprecated:: 3.10

Use classficationMethod instead.
Use :py:func:`~QgsGraduatedSymbolRenderer.classficationMethod` instead.
%End

static void makeBreaksSymmetric( QList<double> &breaks /In,Out/, double symmetryPoint, bool astride ) /Deprecated/;
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -534,7 +534,7 @@ Returns a large (roughly 100x100 pixel) preview image for the symbol.

.. deprecated:: 3.40

Use bigSymbolPreviewImageV2 instead.
Use :py:func:`~QgsSymbol.bigSymbolPreviewImageV2` instead.
%End

QString dump() const;
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -136,7 +136,7 @@ The symbol layer's id

.. deprecated:: 3.30

Use symbolLayerIdV2 instead.
Use :py:func:`~QgsSymbolLayerReference.symbolLayerIdV2` instead.
%End

QString symbolLayerIdV2() const;
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -562,7 +562,7 @@ Returns the transaction this data provider is included in, if any.

.. deprecated:: 3.12

Will be removed in QGIS 4.0 - use reloadData instead.
Will be removed in QGIS 4.0 - use :py:func:`~QgsVectorDataProvider.reloadData` instead.
%End

virtual QSet<QgsMapLayerDependency> dependencies() const;
Expand Down
4 changes: 2 additions & 2 deletions python/PyQt6/core/auto_generated/vector/qgsvectorlayer.sip.in
Original file line number Diff line number Diff line change
Expand Up @@ -1968,7 +1968,7 @@ A set of attributes that are not advertised in WMS requests with QGIS server.

.. deprecated:: 3.16

Use setFieldConfigurationFlag instead.
Use :py:func:`~QgsVectorLayer.setFieldConfigurationFlag` instead.
%End

QSet<QString> excludeAttributesWfs() const /Deprecated/;
Expand All @@ -1986,7 +1986,7 @@ A set of attributes that are not advertised in WFS requests with QGIS server.

.. deprecated:: 3.16

Use setFieldConfigurationFlag instead.
Use :py:func:`~QgsVectorLayer.setFieldConfigurationFlag` instead.
%End

virtual bool deleteAttribute( int attr );
Expand Down
Loading

0 comments on commit 8ec6807

Please sign in to comment.