Skip to content
Permalink
Browse files

Fix boolean literal presentation in dox/PyQGIS docs

  • Loading branch information
nyalldawson committed Oct 16, 2020
1 parent 3ffbed3 commit 746ee315bd0a4140f6e84617d547cc89103f79aa
Showing with 622 additions and 622 deletions.
  1. +1 −1 python/3d/auto_generated/materials/qgsphongtexturedmaterialsettings.sip.in
  2. +1 −1 python/analysis/auto_generated/raster/qgsrelief.sip.in
  3. +1 −1 python/core/auto_generated/classification/qgsclassificationmethodregistry.sip.in
  4. +3 −3 python/core/auto_generated/geometry/qgsgeometry.sip.in
  5. +1 −1 python/core/auto_generated/geometry/qgsgeometryengine.sip.in
  6. +2 −2 python/core/auto_generated/geometry/qgsgeometryutils.sip.in
  7. +2 −2 python/core/auto_generated/layertree/qgslayertreelayer.sip.in
  8. +1 −1 python/core/auto_generated/layout/qgslayoutitemnodeitem.sip.in
  9. +6 −6 python/core/auto_generated/mesh/qgsmesh3daveraging.sip.in
  10. +1 −1 python/core/auto_generated/mesh/qgsmeshdataprovider.sip.in
  11. +1 −1 python/core/auto_generated/mesh/qgsmeshdataset.sip.in
  12. +1 −1 python/core/auto_generated/qgsmaplayer.sip.in
  13. +1 −1 python/core/auto_generated/qgspointlocator.sip.in
  14. +1 −1 python/core/auto_generated/qgsproperty.sip.in
  15. +2 −2 python/core/auto_generated/qgspropertycollection.sip.in
  16. +2 −2 python/core/auto_generated/qgsprovidermetadata.sip.in
  17. +1 −1 python/core/auto_generated/qgsstringutils.sip.in
  18. +1 −1 python/core/auto_generated/qgsvectorlayereditbuffer.sip.in
  19. +1 −1 python/core/auto_generated/qgsvectorlayerjoinbuffer.sip.in
  20. +1 −1 python/core/auto_generated/qgsvectorlayerjoininfo.sip.in
  21. +1 −1 python/core/auto_generated/qgsvectorlayertools.sip.in
  22. +2 −2 python/core/auto_generated/qgsvectorlayerutils.sip.in
  23. +5 −5 python/core/auto_generated/raster/qgsrasterdataprovider.sip.in
  24. +1 −1 python/core/auto_generated/symbology/qgslinesymbollayer.sip.in
  25. +1 −1 python/core/auto_generated/symbology/qgsrendererrange.sip.in
  26. +4 −4 python/core/auto_generated/symbology/qgssymbol.sip.in
  27. +1 −1 python/core/auto_generated/vectortile/qgsvectortilewriter.sip.in
  28. +1 −1 python/gui/auto_generated/editorwidgets/core/qgseditorwidgetwrapper.sip.in
  29. +1 −1 python/gui/auto_generated/editorwidgets/qgsrelationwidgetwrapper.sip.in
  30. +2 −2 python/gui/auto_generated/qgisinterface.sip.in
  31. +1 −1 python/gui/auto_generated/qgsdataitemguiprovider.sip.in
  32. +1 −1 python/gui/auto_generated/qgsmapcanvas.sip.in
  33. +1 −1 python/gui/auto_generated/qgsmapcanvasitem.sip.in
  34. +1 −1 python/gui/auto_generated/qgsmaplayerconfigwidget.sip.in
  35. +2 −2 python/gui/auto_generated/qgsmaptooldigitizefeature.sip.in
  36. +2 −2 python/gui/auto_generated/qgsscalecombobox.sip.in
  37. +2 −2 python/gui/auto_generated/qgsscalewidget.sip.in
  38. +1 −1 src/3d/materials/qgsphongtexturedmaterialsettings.h
  39. +1 −1 src/3d/mesh/qgsmesh3dgeometry_p.cpp
  40. +1 −1 src/3d/qgs3dsceneexporter.h
  41. +1 −1 src/analysis/raster/qgsrelief.h
  42. +1 −1 src/app/3d/qgs3dmaptool.h
  43. +1 −1 src/app/decorations/qgsdecorationlayoutextent.h
  44. +1 −1 src/app/georeferencer/qgsgeorefmainwindow.h
  45. +3 −3 src/app/georeferencer/qgsgeoreftransform.h
  46. +18 −18 src/app/labeling/qgsmaptoollabel.h
  47. +1 −1 src/app/layout/qgslayoutdesignerdialog.h
  48. +2 −2 src/app/options/qgsoptions.h
  49. +20 −20 src/app/qgisapp.h
  50. +1 −1 src/app/qgsclipboard.h
  51. +2 −2 src/app/qgsfeatureaction.h
  52. +1 −1 src/app/qgsguivectorlayertools.h
  53. +1 −1 src/app/qgslayerstylingwidget.h
  54. +5 −5 src/app/qgsmapcanvasdockwidget.h
  55. +1 −1 src/app/qgsmaptooladdfeature.h
  56. +1 −1 src/app/qgsmaptooloffsetpointsymbol.h
  57. +1 −1 src/app/qgsmaptoolrotatepointsymbols.h
  58. +1 −1 src/app/qgsmeasuredialog.h
  59. +1 −1 src/app/vertextool/qgslockedfeature.h
  60. +1 −1 src/core/classification/qgsclassificationmethodregistry.h
  61. +3 −3 src/core/geometry/qgsgeometry.h
  62. +1 −1 src/core/geometry/qgsgeometryengine.h
  63. +2 −2 src/core/geometry/qgsgeometryutils.h
  64. +1 −1 src/core/labeling/qgspallabeling.h
  65. +2 −2 src/core/layertree/qgslayertreelayer.h
  66. +1 −1 src/core/layout/qgslayoutitemlegend.h
  67. +1 −1 src/core/layout/qgslayoutitemnodeitem.h
  68. +6 −6 src/core/mesh/qgsmesh3daveraging.h
  69. +1 −1 src/core/mesh/qgsmeshcalcnode.h
  70. +1 −1 src/core/mesh/qgsmeshdataprovider.h
  71. +1 −1 src/core/mesh/qgsmeshdataset.h
  72. +1 −1 src/core/mesh/qgsmeshlayerutils.h
  73. +1 −1 src/core/mesh/qgstriangularmesh.h
  74. +1 −1 src/core/pal/pal.h
  75. +1 −1 src/core/pal/priorityqueue.h
  76. +1 −1 src/core/pal/problem.h
  77. +1 −1 src/core/providers/gdal/qgsgdalprovider.cpp
  78. +1 −1 src/core/providers/gdal/qgsgdalproviderbase.cpp
  79. +1 −1 src/core/providers/ogr/qgsgeopackagedataitems.h
  80. +1 −1 src/core/providers/ogr/qgsogrprovider.h
  81. +2 −2 src/core/providers/ogr/qgsogrtransaction.h
  82. +1 −1 src/core/qgis.h
  83. +1 −1 src/core/qgseditformconfig.h
  84. +3 −3 src/core/qgseventtracing.h
  85. +1 −1 src/core/qgsmaplayer.h
  86. +1 −1 src/core/qgsmbtiles.h
  87. +1 −1 src/core/qgspointlocator.h
  88. +1 −1 src/core/qgsproperty.h
  89. +2 −2 src/core/qgspropertycollection.h
  90. +2 −2 src/core/qgsprovidermetadata.h
  91. +1 −1 src/core/qgsstringutils.h
  92. +1 −1 src/core/qgstilecache.h
  93. +1 −1 src/core/qgsvectorlayereditbuffer.h
  94. +1 −1 src/core/qgsvectorlayerfeatureiterator.cpp
  95. +1 −1 src/core/qgsvectorlayerjoinbuffer.h
  96. +1 −1 src/core/qgsvectorlayerjoininfo.h
  97. +1 −1 src/core/qgsvectorlayertools.h
  98. +2 −2 src/core/qgsvectorlayerutils.h
  99. +5 −5 src/core/raster/qgsrasterdataprovider.h
  100. +1 −1 src/core/raster/qgsrasterlayer.cpp
  101. +1 −1 src/core/symbology/qgsarrowsymbollayer.cpp
  102. +1 −1 src/core/symbology/qgslinesymbollayer.h
  103. +1 −1 src/core/symbology/qgsrendererrange.h
  104. +4 −4 src/core/symbology/qgssymbol.h
  105. +1 −1 src/core/vectortile/qgsvectortilewriter.h
  106. +1 −1 src/gui/codeeditors/qgscodeeditorexpression.h
  107. +1 −1 src/gui/codeeditors/qgscodeeditorsql.h
  108. +1 −1 src/gui/editorwidgets/core/qgseditorwidgetwrapper.h
  109. +1 −1 src/gui/editorwidgets/qgsrelationwidgetwrapper.h
  110. +1 −1 src/gui/layout/qgslayoutattributeselectiondialog.h
  111. +1 −1 src/gui/layout/qgslayoutimageexportoptionsdialog.h
  112. +2 −2 src/gui/qgisinterface.h
  113. +1 −1 src/gui/qgsdataitemguiprovider.h
  114. +1 −1 src/gui/qgsdatumtransformdialog.h
  115. +1 −1 src/gui/qgsgui.h
  116. +2 −2 src/gui/qgsguiutils.h
  117. +2 −2 src/gui/qgsmapcanvas.h
  118. +1 −1 src/gui/qgsmapcanvasitem.h
  119. +1 −1 src/gui/qgsmaplayerconfigwidget.h
  120. +3 −3 src/gui/qgsmaptooldigitizefeature.h
  121. +2 −2 src/gui/qgsscalecombobox.h
  122. +2 −2 src/gui/qgsscalewidget.h
  123. +1 −1 src/gui/vector/qgssourcefieldsproperties.h
  124. +1 −1 src/plugins/grass/qgsgrassmoduleoptions.h
  125. +402 −402 src/plugins/grass/qtermwidget/Emulation.h
@@ -81,7 +81,7 @@ If the texture scale is less than 1 the texture will be stretched

bool requiresTextureCoordinates() const;
%Docstring
Returns true if the material requires texture coordinates to be generated
Returns ``True`` if the material requires texture coordinates to be generated
during triangulation.quiresTextureCoordinates
%End

@@ -53,7 +53,7 @@ Starts the calculation, reads from mInputFile and stores the result in mOutputFi
%Docstring
Calculates class breaks according with the method of Buenzli (2011) using an iterative algorithm for segmented regression

:return: true in case of success
:return: ``True`` in case of success
%End

bool exportFrequencyDistributionToCsv( const QString &file );
@@ -33,7 +33,7 @@ QgsClassificationMethodRegistry is not usually directly created, but rather acce
bool addMethod( QgsClassificationMethod *method /Transfer/ );
%Docstring
Adds a method to the registry
Returns false if a method with same id already exists.
Returns ``False`` if a method with same id already exists.
%End

QgsClassificationMethod *method( const QString &id ) /Factory/;
@@ -849,7 +849,7 @@ Splits this geometry according to a given line.
\param[out] newGeometries list of new geometries that have been created with the split
:param topological: ``True`` if topological editing is enabled
\param[out] topologyTestPoints points that need to be tested for topological completeness in the dataset
:param splitFeature: Set to True if you want to split a feature, otherwise set to False to split parts
:param splitFeature: Set to ``True`` if you want to split a feature, otherwise set to ``False`` to split parts

:return: OperationResult a result code: success or reason of failure

@@ -865,7 +865,7 @@ Splits this geometry according to a given line.
\param[out] newGeometries list of new geometries that have been created with the ``splitLine``. If the geometry is 3D, a linear interpolation of the z value is performed on the geometry at split points, see example.
:param topological: ``True`` if topological editing is enabled
\param[out] topologyTestPoints points that need to be tested for topological completeness in the dataset
:param splitFeature: Set to True if you want to split a feature, otherwise set to False to split parts
:param splitFeature: Set to ``True`` if you want to split a feature, otherwise set to ``False`` to split parts
fix this bug?

:return: OperationResult a result code: success or reason of failure
@@ -889,7 +889,7 @@ Splits this geometry according to a given curve.
:param preserveCircular: whether if circular strings are preserved after splitting
:param topological: ``True`` if topological editing is enabled
\param[out] topologyTestPoints points that need to be tested for topological completeness in the dataset
:param splitFeature: Set to True if you want to split a feature, otherwise set to False to split parts
:param splitFeature: Set to ``True`` if you want to split a feature, otherwise set to ``False`` to split parts

:return: OperationResult a result code: success or reason of failure

@@ -210,7 +210,7 @@ pattern.

virtual bool isValid( QString *errorMsg = 0, bool allowSelfTouchingHoles = false, QgsGeometry *errorLoc = 0 ) const = 0;
%Docstring
Returns true if the geometry is valid.
Returns ``True`` if the geometry is valid.

If the geometry is invalid, ``errorMsg`` will be filled with the reported geometry error.

@@ -111,7 +111,7 @@ Compute the intersection between two segments
:param q1: Second segment start point
:param q2: Second segment end point
:param tolerance: The tolerance to use
:param acceptImproperIntersection: By default, this method returns true only if segments have proper intersection. If set true, returns also ``True`` if segments have improper intersection (end of one segment on other segment ; continuous segments).
:param acceptImproperIntersection: By default, this method returns ``True`` only if segments have proper intersection. If set true, returns also ``True`` if segments have improper intersection (end of one segment on other segment ; continuous segments).

:return: - Whether the segments intersect
- intersectionPoint: Output parameter, the intersection point
@@ -360,7 +360,7 @@ Convert circular arc defined by p1, p2, p3 (p1/p3 being start resp. end point, p
static bool pointContinuesArc( const QgsPoint &a1, const QgsPoint &a2, const QgsPoint &a3, const QgsPoint &b, double distanceTolerance,
double pointSpacingAngleTolerance ) /HoldGIL/;
%Docstring
Returns true if point ``b`` is on the arc formed by points ``a1``, ``a2``, and ``a3``, but not within
Returns ``True`` if point ``b`` is on the arc formed by points ``a1``, ``a2``, and ``a3``, but not within
that arc portion already described by ``a1``, ``a2`` and ``a3``.

The ``distanceTolerance`` specifies the maximum deviation allowed between the original location
@@ -80,8 +80,8 @@ Sets the layer's name.

void setUseLayerName( bool use = true );
%Docstring
Uses the layer's name if ``use`` is true, or the name manually set if
false.
Uses the layer's name if ``use`` is ``True``, or the name manually set if
``False``.

.. versionadded:: 3.8
%End
@@ -44,7 +44,7 @@ Add a node in current shape.
:param point: is the location of the new node (in scene coordinates)
:param checkArea: is a flag to indicate if there's a space constraint.
:param radius: is the space contraint and is used only if checkArea is
true. Typically, if this flag is ``True``, the new node has to be nearer
``True``. Typically, if this flag is ``True``, the new node has to be nearer
than radius to the shape to be added.
%End

@@ -138,17 +138,17 @@ Constructs multi level averaging method

:param startLevel: starting vertical level index numbered from 1
:param endLevel: ending vertical level index numbered from 1 (higher or equal than startLevel)
:param countedFromTop: if true, the startLevel index is counted from surface (index 1 is the top layer).
if false, the startLevel index is counted from the bed level (index 1 is the bottom layer)
:param countedFromTop: if ``True``, the startLevel index is counted from surface (index 1 is the top layer).
if ``False``, the startLevel index is counted from the bed level (index 1 is the bottom layer)
%End

QgsMeshMultiLevelsAveragingMethod( int verticalLevel, bool countedFromTop );
%Docstring
Constructs single level averaging method

:param verticalLevel: vertical level index numbered from 1
:param countedFromTop: if true, the startLevel index is counted from surface (index 1 is the top layer).
if false, the startLevel index is counted from the bed level (index 1 is the bottom layer)
:param countedFromTop: if ``True``, the startLevel index is counted from surface (index 1 is the top layer).
if ``False``, the startLevel index is counted from the bed level (index 1 is the bottom layer)
%End

~QgsMeshMultiLevelsAveragingMethod();
@@ -284,8 +284,8 @@ Constructs the depth/height averaging method

:param startHeight: starting depth/height, higher or equal than 0
:param endHeight: ending depth/height, higher or equal than startDepth
:param countedFromTop: if true, the startLength and endLength is relative to surface (0 is surface level).
if false, the startLength and endLength is relative to bed (0 is bed level).
:param countedFromTop: if ``True``, the startLength and endLength is relative to surface (0 is surface level).
if ``False``, the startLength and endLength is relative to bed (0 is bed level).
%End

~QgsMeshRelativeHeightAveragingMethod();
@@ -77,7 +77,7 @@ Remove all vertices, edges and faces

static bool compareFaces( const QgsMeshFace &face1, const QgsMeshFace &face2 );
%Docstring
Compare two faces, return true if they are equivalent : same indexes and same clock wise
Compare two faces, return ``True`` if they are equivalent : same indexes and same clock wise

.. versionadded:: 3.16
%End
@@ -194,7 +194,7 @@ Sets active flag values.

If the data provider/datasets does not have active
flag capability (== all values are valid), just
set block validity by setValid( true )
set block validity by setValid( ``True`` )

:param vals: value vector with size :py:func:`~QgsMeshDataBlock.count`

@@ -1725,7 +1725,7 @@ Sets error message
bool hasDependencyCycle( const QSet<QgsMapLayerDependency> & ) const;
%Docstring
Checks whether a new set of dependencies will introduce a cycle
this method is now deprecated and always return false, because circular dependencies are now correctly managed.
this method is now deprecated and always return ``False``, because circular dependencies are now correctly managed.

.. deprecated:: QGIS 3.10
%End
@@ -110,7 +110,7 @@ This method is either blocking or non blocking according to ``relaxed`` paramete
in the constructor. if ``True``, index building will be done in another thread and :py:func:`~QgsPointLocator.init` method returns
immediately. :py:func:`~QgsPointLocator.initFinished` signal will be emitted once the initialization is over.

Returns false if the creation of index is blocking and has been prematurely stopped due to the limit of features, otherwise true
Returns ``False`` if the creation of index is blocking and has been prematurely stopped due to the limit of features, otherwise ``True``

.. seealso:: :py:class:`QgsPointLocator`
%End
@@ -315,7 +315,7 @@ expression context.

.. note::

The optional argument ignoreContext has been added in QGIS 3.14. When set to true,
The optional argument ignoreContext has been added in QGIS 3.14. When set to ``True``,
even fields not set in context's :py:func:`~QgsProperty.fields` will be reported - this is useful e.g. with vector tiles
where the actual available field names may not be known beforehand.
%End
@@ -276,7 +276,7 @@ Returns ``True`` if preparation was successful.
Returns the set of any fields referenced by the active properties from the collection.

:param context: expression context the properties will be evaluated against.
:param ignoreContext: This parameter has been added in QGIS 3.14. When set to true, even fields not set
:param ignoreContext: This parameter has been added in QGIS 3.14. When set to ``True``, even fields not set
in context's :py:func:`~QgsAbstractPropertyCollection.fields` will be reported - this is useful e.g. with vector tiles
where the actual available field names may not be known beforehand.
%End
@@ -588,7 +588,7 @@ Returns the calculated value of the highest priority property with the specified
Returns the set of any fields referenced by the active properties from the stack.

:param context: expression context the properties will be evaluated against.
:param ignoreContext: This parameter has been added in QGIS 3.14. When set to true, even fields not set
:param ignoreContext: This parameter has been added in QGIS 3.14. When set to ``True``, even fields not set
in context's :py:func:`~QgsPropertyCollectionStack.fields` will be reported - this is useful e.g. with vector tiles
where the actual available field names may not be known beforehand.
%End
@@ -197,15 +197,15 @@ Class factory to return a pointer to a newly created QgsDataProvider object
static void setBoolParameter( QVariantMap &uri, const QString &parameter, const QVariant &value );
%Docstring
Sets the ``value`` into the ``uri`` ``parameter`` as a bool.
eg. "yes" value will be saved as true, 0 will be saved as false
eg. "yes" value will be saved as ``True``, 0 will be saved as ``False``

.. versionadded:: 3.14
%End

static bool boolParameter( const QVariantMap &uri, const QString &parameter, bool defaultValue = false );
%Docstring
Returns the ``parameter`` value in the ``uri`` as a bool.
eg. "yes" value will be returned as true, 0 will be returned as false
eg. "yes" value will be returned as ``True``, 0 will be returned as ``False``

.. versionadded:: 3.14
%End
@@ -285,7 +285,7 @@ links.
Automatically wraps a ``string`` by inserting new line characters at appropriate locations in the string.

The ``length`` argument specifies either the minimum or maximum length of lines desired, depending
on whether ``useMaxLineLength`` is true. If ``useMaxLineLength`` is ``True``, then the string will be wrapped
on whether ``useMaxLineLength`` is ``True``. If ``useMaxLineLength`` is ``True``, then the string will be wrapped
so that each line ideally will not exceed ``length`` of characters. If ``useMaxLineLength`` is ``False``, then
the string will be wrapped so that each line will ideally exceed ``length`` of characters.

@@ -32,7 +32,7 @@ Adds a feature

:param f: feature to add

:return: ``True`` in case of success and False in case of error
:return: ``True`` in case of success and ``False`` in case of error
%End

virtual bool addFeatures( QgsFeatureList &features );
@@ -39,7 +39,7 @@ Joins another vector layer to this layer
%Docstring
Removes a vector layer join

:return: true if join was found and successfully removed
:return: ``True`` if join was found and successfully removed
%End

void updateFields( QgsFields &fields );
@@ -81,7 +81,7 @@ Sets whether values from the joined layer should be cached in memory to speed up
bool isUsingMemoryCache() const;
%Docstring
Returns whether values from the joined layer should be cached in memory to speed up lookups.
Will return false if upsertOnEdit is enabled.
Will return ``False`` if upsertOnEdit is enabled.
%End

bool isDynamicFormEnabled() const;
@@ -83,7 +83,7 @@ Copy and move features with defined translation.
:param request: The request for the features to be moved. It will be assigned to a new feature request with the newly copied features.
:param dx: The translation on x
:param dy: The translation on y
:param topologicalEditing: If true, the function will perform topological
:param topologicalEditing: If ``True``, the function will perform topological
editing of the vertices of ``layer`` on ``layer`` and ``topologicalLayer``
:param topologicalLayer: The layer where vertices from the moved features of ``layer`` will be added

@@ -286,8 +286,8 @@ Optionally, ``sinkFlags`` can be specified to further refine the compatibility l
static bool fieldIsEditable( const QgsVectorLayer *layer, int fieldIndex, const QgsFeature &feature );
%Docstring

:return: true if the:param feature: field at index:param fieldIndex: from:param layer:
is editable, false if the field is readonly
:return: ``True`` if the:param feature: field at index:param fieldIndex: from:param layer:
is editable, ``False`` if the field is readonly

.. versionadded:: 3.10
%End
@@ -493,7 +493,7 @@ Resolutions are calculated in the provider's :py:func:`~QgsRasterDataProvider.cr

virtual bool ignoreExtents() const;
%Docstring
Returns true if the extents reported by the data provider are not reliable
Returns ``True`` if the extents reported by the data provider are not reliable
and it's possible that there is renderable content outside of these extents.

.. versionadded:: 3.10.0
@@ -524,7 +524,7 @@ does not support this functionality), an empty point is returned.
%Docstring
Enable or disable provider-level resampling.

:return: true if success
:return: ``True`` if success

.. versionadded:: 3.16
%End
@@ -559,7 +559,7 @@ Returns whether provider-level resampling is enabled.
%Docstring
Set resampling method to apply for zoomed-in operations.

:return: true if success
:return: ``True`` if success

.. versionadded:: 3.16
%End
@@ -575,7 +575,7 @@ Returns resampling method for zoomed-in operations.
%Docstring
Set resampling method to apply for zoomed-out operations.

:return: true if success
:return: ``True`` if success

.. versionadded:: 3.16
%End
@@ -591,7 +591,7 @@ Returns resampling method for zoomed-out operations.
%Docstring
Sets maximum oversampling factor for zoomed-out operations.

:return: true if success
:return: ``True`` if success

.. versionadded:: 3.16
%End
@@ -690,7 +690,7 @@ If only a single symbol layer from the symbol should be rendered, it should be s
in the ``layer`` argument. A ``layer`` of -1 indicates that all symbol layers should be
rendered.

If ``selected`` is true then the symbol will be drawn using the "selected feature"
If ``selected`` is ``True`` then the symbol will be drawn using the "selected feature"
style and colors instead of the symbol's normal style.
%End

@@ -31,7 +31,7 @@ Creates a renderer symbol range

:param range: The classification range
:param symbol: The symbol for this renderer range
:param render: If true, it will be renderered
:param render: If ``True``, it will be renderered
%End
QgsRendererRange( double lowerValue, double upperValue, QgsSymbol *symbol /Transfer/, const QString &label, bool render = true );
QgsRendererRange( const QgsRendererRange &range );
@@ -435,7 +435,7 @@ extent. If this option is enabled then features which are partially outside the
will be clipped. This speeds up rendering of the feature, but may have undesirable
side effects for certain symbol types.

:param clipFeaturesToExtent: set to true to enable clipping (defaults to ``True``)
:param clipFeaturesToExtent: set to ``True`` to enable clipping (defaults to ``True``)

.. seealso:: :py:func:`clipFeaturesToExtent`

@@ -1053,7 +1053,7 @@ If only a single symbol layer from the symbol should be rendered, it should be s
in the ``layer`` argument. A ``layer`` of -1 indicates that all symbol layers should be
rendered.

If ``selected`` is true then the symbol will be drawn using the "selected feature"
If ``selected`` is ``True`` then the symbol will be drawn using the "selected feature"
style and colors instead of the symbol's normal style.
%End

@@ -1180,7 +1180,7 @@ If only a single symbol layer from the symbol should be rendered, it should be s
in the ``layer`` argument. A ``layer`` of -1 indicates that all symbol layers should be
rendered.

If ``selected`` is true then the symbol will be drawn using the "selected feature"
If ``selected`` is ``True`` then the symbol will be drawn using the "selected feature"
style and colors instead of the symbol's normal style.
%End

@@ -1229,7 +1229,7 @@ If only a single symbol layer from the symbol should be rendered, it should be s
in the ``layer`` argument. A ``layer`` of -1 indicates that all symbol layers should be
rendered.

If ``selected`` is true then the symbol will be drawn using the "selected feature"
If ``selected`` is ``True`` then the symbol will be drawn using the "selected feature"
style and colors instead of the symbol's normal style.
%End

@@ -159,7 +159,7 @@ Sets coordinate transform context for transforms between layers and tile matrix
bool writeTiles( QgsFeedback *feedback = 0 );
%Docstring
Writes vector tiles according to the configuration.
Returns true on success (upon failure one can get error cause using :py:func:`~QgsVectorTileWriter.errorMessage`)
Returns ``True`` on success (upon failure one can get error cause using :py:func:`~QgsVectorTileWriter.errorMessage`)

If a pointer to a feedback object is provided, it can be used to track progress or
provide cancellation functionality.
@@ -180,7 +180,7 @@ Gets the current constraint status.

bool isBlockingCommit() const;
%Docstring
Returns true if the widget is preventing the feature from being committed. This may be ``True`` as a result
Returns ``True`` if the widget is preventing the feature from being committed. This may be ``True`` as a result
of attribute values failing enforced field constraints.

.. seealso:: :py:func:`isValidConstraint`

0 comments on commit 746ee31

Please sign in to comment.
You can’t perform that action at this time.