Fix boolean literal presentation in dox/PyQGIS docs

qgis · Oct 16, 2020 · 746ee31 · 746ee31
1 parent 3ffbed3
commit 746ee31
Show file tree

Hide file tree

Showing 125 changed files with 622 additions and 622 deletions.
diff --git a/python/3d/auto_generated/materials/qgsphongtexturedmaterialsettings.sip.in b/python/3d/auto_generated/materials/qgsphongtexturedmaterialsettings.sip.in
@@ -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
 

diff --git a/python/analysis/auto_generated/raster/qgsrelief.sip.in b/python/analysis/auto_generated/raster/qgsrelief.sip.in
@@ -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 );

diff --git a/python/core/auto_generated/classification/qgsclassificationmethodregistry.sip.in b/python/core/auto_generated/classification/qgsclassificationmethodregistry.sip.in
@@ -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/;

diff --git a/python/core/auto_generated/geometry/qgsgeometry.sip.in b/python/core/auto_generated/geometry/qgsgeometry.sip.in
@@ -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
 

diff --git a/python/core/auto_generated/geometry/qgsgeometryengine.sip.in b/python/core/auto_generated/geometry/qgsgeometryengine.sip.in
@@ -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.
 

diff --git a/python/core/auto_generated/geometry/qgsgeometryutils.sip.in b/python/core/auto_generated/geometry/qgsgeometryutils.sip.in
@@ -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

diff --git a/python/core/auto_generated/layertree/qgslayertreelayer.sip.in b/python/core/auto_generated/layertree/qgslayertreelayer.sip.in
@@ -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

diff --git a/python/core/auto_generated/layout/qgslayoutitemnodeitem.sip.in b/python/core/auto_generated/layout/qgslayoutitemnodeitem.sip.in
@@ -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
 

diff --git a/python/core/auto_generated/mesh/qgsmesh3daveraging.sip.in b/python/core/auto_generated/mesh/qgsmesh3daveraging.sip.in
@@ -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();

diff --git a/python/core/auto_generated/mesh/qgsmeshdataprovider.sip.in b/python/core/auto_generated/mesh/qgsmeshdataprovider.sip.in
@@ -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

diff --git a/python/core/auto_generated/mesh/qgsmeshdataset.sip.in b/python/core/auto_generated/mesh/qgsmeshdataset.sip.in
@@ -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`
 

diff --git a/python/core/auto_generated/qgsmaplayer.sip.in b/python/core/auto_generated/qgsmaplayer.sip.in
@@ -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

diff --git a/python/core/auto_generated/qgspointlocator.sip.in b/python/core/auto_generated/qgspointlocator.sip.in
@@ -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

diff --git a/python/core/auto_generated/qgsproperty.sip.in b/python/core/auto_generated/qgsproperty.sip.in
@@ -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

diff --git a/python/core/auto_generated/qgspropertycollection.sip.in b/python/core/auto_generated/qgspropertycollection.sip.in
@@ -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

diff --git a/python/core/auto_generated/qgsprovidermetadata.sip.in b/python/core/auto_generated/qgsprovidermetadata.sip.in
@@ -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

diff --git a/python/core/auto_generated/qgsstringutils.sip.in b/python/core/auto_generated/qgsstringutils.sip.in
@@ -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.
 

diff --git a/python/core/auto_generated/qgsvectorlayereditbuffer.sip.in b/python/core/auto_generated/qgsvectorlayereditbuffer.sip.in
@@ -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 );

diff --git a/python/core/auto_generated/qgsvectorlayerjoinbuffer.sip.in b/python/core/auto_generated/qgsvectorlayerjoinbuffer.sip.in
@@ -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 );

diff --git a/python/core/auto_generated/qgsvectorlayerjoininfo.sip.in b/python/core/auto_generated/qgsvectorlayerjoininfo.sip.in
@@ -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;

diff --git a/python/core/auto_generated/qgsvectorlayertools.sip.in b/python/core/auto_generated/qgsvectorlayertools.sip.in
@@ -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
 

diff --git a/python/core/auto_generated/qgsvectorlayerutils.sip.in b/python/core/auto_generated/qgsvectorlayerutils.sip.in
@@ -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

diff --git a/python/core/auto_generated/raster/qgsrasterdataprovider.sip.in b/python/core/auto_generated/raster/qgsrasterdataprovider.sip.in
@@ -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

diff --git a/python/core/auto_generated/symbology/qgslinesymbollayer.sip.in b/python/core/auto_generated/symbology/qgslinesymbollayer.sip.in
@@ -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
 

diff --git a/python/core/auto_generated/symbology/qgsrendererrange.sip.in b/python/core/auto_generated/symbology/qgsrendererrange.sip.in
@@ -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 );

diff --git a/python/core/auto_generated/symbology/qgssymbol.sip.in b/python/core/auto_generated/symbology/qgssymbol.sip.in
@@ -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
 

diff --git a/python/core/auto_generated/vectortile/qgsvectortilewriter.sip.in b/python/core/auto_generated/vectortile/qgsvectortilewriter.sip.in
@@ -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.

diff --git a/python/gui/auto_generated/editorwidgets/core/qgseditorwidgetwrapper.sip.in b/python/gui/auto_generated/editorwidgets/core/qgseditorwidgetwrapper.sip.in
@@ -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`