Rewording and formatting in PyQGIS docs

python/PyQt6/core/auto_additions/qgis.py

@@ -2279,7 +2279,7 @@
 QgsPalLayerSettings.QuadrantBelowRight = Qgis.LabelQuadrantPosition.BelowRight
 QgsPalLayerSettings.QuadrantPosition.QuadrantBelowRight = Qgis.LabelQuadrantPosition.BelowRight
 QgsPalLayerSettings.QuadrantBelowRight.is_monkey_patched = True
-QgsPalLayerSettings.QuadrantBelowRight.__doc__ = "BelowRight"
+QgsPalLayerSettings.QuadrantBelowRight.__doc__ = "Below right"
 Qgis.LabelQuadrantPosition.__doc__ = """Label quadrant positions
 
 .. note::
@@ -2320,7 +2320,7 @@
 
   Available as ``QgsPalLayerSettings.QuadrantBelow`` in older QGIS releases.
 
-* ``BelowRight``: BelowRight
+* ``BelowRight``: Below right
 
   Available as ``QgsPalLayerSettings.QuadrantBelowRight`` in older QGIS releases.
 

python/PyQt6/core/auto_generated/qgsmaplayermodel.sip.in

@@ -38,21 +38,21 @@ The :py:class:`QgsMapLayerModel` class is a model to display layers in widgets.
 %Docstring
 QgsMapLayerModel creates a model to display layers in widgets.
 
-If a specific ``project`` is not specified then the :py:func:`QgsProject.instance()` project will be used to
+If ``project`` is not specified then the :py:func:`QgsProject.instance()` project will be used to
 populate the model.
 %End
 
     explicit QgsMapLayerModel( const QList<QgsMapLayer *> &layers, QObject *parent = 0, QgsProject *project = 0 );
 %Docstring
 QgsMapLayerModel creates a model to display a specific list of layers in a widget.
 
-If a specific ``project`` is not specified then the :py:func:`QgsProject.instance()` project will be used to
+If ``project`` is not specified then the :py:func:`QgsProject.instance()` project will be used to
 populate the model.
 %End
 
     void setItemsCheckable( bool checkable );
 %Docstring
-setItemsCheckable defines if layers should be selectable in the widget
+Defines if layers should be selectable in the widget
 %End
 
     void setProject( QgsProject *project );
@@ -117,7 +117,7 @@ Returns ``True`` if the model includes layer's CRS in the display role.
 
     QList<QgsMapLayer *> layersChecked( Qt::CheckState checkState = Qt::Checked );
 %Docstring
-layersChecked returns the list of layers which are checked (or unchecked)
+Returns the list of layers which are checked (or unchecked)
 %End
 
     void setLayersChecked( const QList< QgsMapLayer * > &layers );
@@ -127,7 +127,7 @@ Sets which layers are checked in the model.
 
     bool itemsCheckable() const;
 %Docstring
-returns if the items can be checked or not
+Returns if the items can be checked or not
 %End
 
     QModelIndex indexFromLayer( QgsMapLayer *layer ) const;

python/PyQt6/gui/auto_generated/qgsmapcanvas.sip.in

@@ -485,27 +485,35 @@ all their child layers.
 
     void freeze( bool frozen = true );
 %Docstring
-Freeze/thaw the map canvas. This is used to prevent the canvas from
+Freezes/thaws the map canvas. This is used to prevent the canvas from
 responding to events while layers are being added/removed etc.
 
 :param frozen: Boolean specifying if the canvas should be frozen (``True``) or
                thawed (``False``). Default is ``True``.
 
 .. seealso:: :py:func:`isFrozen`
 
-.. seealso:: :py:func:`setRenderFlag` freeze() should be used to programmatically halt map updates,
-               while :py:func:`~QgsMapCanvas.setRenderFlag` should only be used when users disable rendering via GUI.
+.. seealso:: :py:func:`setRenderFlag`
+
+.. note::
+
+   :py:func:`~QgsMapCanvas.freeze` should be used to programmatically halt map updates,
+   while :py:func:`~QgsMapCanvas.setRenderFlag` should only be used when users disable rendering via GUI.
 %End
 
     bool isFrozen() const;
 %Docstring
 Returns ``True`` if canvas is frozen.
 
-.. seealso:: :py:func:`renderFlag` isFrozen() should be used to determine whether map updates
-have been halted programmatically, while :py:func:`~QgsMapCanvas.renderFlag` should be used to
-determine whether a user has disabled rendering via GUI.
-
 .. seealso:: :py:func:`freeze`
+
+.. seealso:: :py:func:`renderFlag`
+
+.. note::
+
+   :py:func:`~QgsMapCanvas.isFrozen` should be used to determine whether map updates
+   have been halted programmatically, while :py:func:`~QgsMapCanvas.renderFlag` should be used to
+   determine whether a user has disabled rendering via GUI.
 %End
 
     bool renderFlag() const;
@@ -515,9 +523,13 @@ renders via the GUI.
 
 .. seealso:: :py:func:`setRenderFlag`
 
-.. seealso:: :py:func:`isFrozen` isFrozen() should be used to determine whether map updates
-have been halted programmatically, while :py:func:`~QgsMapCanvas.renderFlag` should be used to
-determine whether a user has disabled rendering via GUI.
+.. seealso:: :py:func:`isFrozen`
+
+.. note::
+
+   :py:func:`~QgsMapCanvas.isFrozen` should be used to determine whether map updates
+   have been halted programmatically, while :py:func:`~QgsMapCanvas.renderFlag` should be used to
+   determine whether a user has disabled rendering via GUI.
 %End
 
     Qgis::DistanceUnit mapUnits() const;
@@ -946,8 +958,12 @@ Sets whether a user has disabled canvas renders via the GUI.
 
 .. seealso:: :py:func:`renderFlag`
 
-.. seealso:: :py:func:`freeze` freeze() should be used to programmatically halt map updates,
-             while :py:func:`~QgsMapCanvas.setRenderFlag` should only be used when users disable rendering via GUI.
+.. seealso:: :py:func:`freeze`
+
+.. note::
+
+   :py:func:`~QgsMapCanvas.freeze` should be used to programmatically halt map updates,
+   while :py:func:`~QgsMapCanvas.setRenderFlag` should only be used when users disable rendering via GUI.
 %End
 
     void stopRendering();

python/core/auto_additions/qgis.py

@@ -2253,7 +2253,7 @@
 QgsPalLayerSettings.QuadrantBelowRight = Qgis.LabelQuadrantPosition.BelowRight
 QgsPalLayerSettings.QuadrantPosition.QuadrantBelowRight = Qgis.LabelQuadrantPosition.BelowRight
 QgsPalLayerSettings.QuadrantBelowRight.is_monkey_patched = True
-QgsPalLayerSettings.QuadrantBelowRight.__doc__ = "BelowRight"
+QgsPalLayerSettings.QuadrantBelowRight.__doc__ = "Below right"
 Qgis.LabelQuadrantPosition.__doc__ = """Label quadrant positions
 
 .. note::
@@ -2294,7 +2294,7 @@
 
   Available as ``QgsPalLayerSettings.QuadrantBelow`` in older QGIS releases.
 
-* ``BelowRight``: BelowRight
+* ``BelowRight``: Below right
 
   Available as ``QgsPalLayerSettings.QuadrantBelowRight`` in older QGIS releases.
 

python/core/auto_generated/qgsmaplayermodel.sip.in

@@ -38,21 +38,21 @@ The :py:class:`QgsMapLayerModel` class is a model to display layers in widgets.
 %Docstring
 QgsMapLayerModel creates a model to display layers in widgets.
 
-If a specific ``project`` is not specified then the :py:func:`QgsProject.instance()` project will be used to
+If ``project`` is not specified then the :py:func:`QgsProject.instance()` project will be used to
 populate the model.
 %End
 
     explicit QgsMapLayerModel( const QList<QgsMapLayer *> &layers, QObject *parent = 0, QgsProject *project = 0 );
 %Docstring
 QgsMapLayerModel creates a model to display a specific list of layers in a widget.
 
-If a specific ``project`` is not specified then the :py:func:`QgsProject.instance()` project will be used to
+If ``project`` is not specified then the :py:func:`QgsProject.instance()` project will be used to
 populate the model.
 %End
 
     void setItemsCheckable( bool checkable );
 %Docstring
-setItemsCheckable defines if layers should be selectable in the widget
+Defines if layers should be selectable in the widget
 %End
 
     void setProject( QgsProject *project );
@@ -117,7 +117,7 @@ Returns ``True`` if the model includes layer's CRS in the display role.
 
     QList<QgsMapLayer *> layersChecked( Qt::CheckState checkState = Qt::Checked );
 %Docstring
-layersChecked returns the list of layers which are checked (or unchecked)
+Returns the list of layers which are checked (or unchecked)
 %End
 
     void setLayersChecked( const QList< QgsMapLayer * > &layers );
@@ -127,7 +127,7 @@ Sets which layers are checked in the model.
 
     bool itemsCheckable() const;
 %Docstring
-returns if the items can be checked or not
+Returns if the items can be checked or not
 %End
 
     QModelIndex indexFromLayer( QgsMapLayer *layer ) const;

python/gui/auto_generated/qgsmapcanvas.sip.in

@@ -485,27 +485,35 @@ all their child layers.
 
     void freeze( bool frozen = true );
 %Docstring
-Freeze/thaw the map canvas. This is used to prevent the canvas from
+Freezes/thaws the map canvas. This is used to prevent the canvas from
 responding to events while layers are being added/removed etc.
 
 :param frozen: Boolean specifying if the canvas should be frozen (``True``) or
                thawed (``False``). Default is ``True``.
 
 .. seealso:: :py:func:`isFrozen`
 
-.. seealso:: :py:func:`setRenderFlag` freeze() should be used to programmatically halt map updates,
-               while :py:func:`~QgsMapCanvas.setRenderFlag` should only be used when users disable rendering via GUI.
+.. seealso:: :py:func:`setRenderFlag`
+
+.. note::
+
+   :py:func:`~QgsMapCanvas.freeze` should be used to programmatically halt map updates,
+   while :py:func:`~QgsMapCanvas.setRenderFlag` should only be used when users disable rendering via GUI.
 %End
 
     bool isFrozen() const;
 %Docstring
 Returns ``True`` if canvas is frozen.
 
-.. seealso:: :py:func:`renderFlag` isFrozen() should be used to determine whether map updates
-have been halted programmatically, while :py:func:`~QgsMapCanvas.renderFlag` should be used to
-determine whether a user has disabled rendering via GUI.
-
 .. seealso:: :py:func:`freeze`
+
+.. seealso:: :py:func:`renderFlag`
+
+.. note::
+
+   :py:func:`~QgsMapCanvas.isFrozen` should be used to determine whether map updates
+   have been halted programmatically, while :py:func:`~QgsMapCanvas.renderFlag` should be used to
+   determine whether a user has disabled rendering via GUI.
 %End
 
     bool renderFlag() const;
@@ -515,9 +523,13 @@ renders via the GUI.
 
 .. seealso:: :py:func:`setRenderFlag`
 
-.. seealso:: :py:func:`isFrozen` isFrozen() should be used to determine whether map updates
-have been halted programmatically, while :py:func:`~QgsMapCanvas.renderFlag` should be used to
-determine whether a user has disabled rendering via GUI.
+.. seealso:: :py:func:`isFrozen`
+
+.. note::
+
+   :py:func:`~QgsMapCanvas.isFrozen` should be used to determine whether map updates
+   have been halted programmatically, while :py:func:`~QgsMapCanvas.renderFlag` should be used to
+   determine whether a user has disabled rendering via GUI.
 %End
 
     Qgis::DistanceUnit mapUnits() const;
@@ -946,8 +958,12 @@ Sets whether a user has disabled canvas renders via the GUI.
 
 .. seealso:: :py:func:`renderFlag`
 
-.. seealso:: :py:func:`freeze` freeze() should be used to programmatically halt map updates,
-             while :py:func:`~QgsMapCanvas.setRenderFlag` should only be used when users disable rendering via GUI.
+.. seealso:: :py:func:`freeze`
+
+.. note::
+
+   :py:func:`~QgsMapCanvas.freeze` should be used to programmatically halt map updates,
+   while :py:func:`~QgsMapCanvas.setRenderFlag` should only be used when users disable rendering via GUI.
 %End
 
     void stopRendering();

src/core/qgis.h

@@ -1192,7 +1192,7 @@ class CORE_EXPORT Qgis
       Right SIP_MONKEYPATCH_COMPAT_NAME( QuadrantRight ), //!< Right middle
       BelowLeft SIP_MONKEYPATCH_COMPAT_NAME( QuadrantBelowLeft ), //!< Below left
       Below SIP_MONKEYPATCH_COMPAT_NAME( QuadrantBelow ), //!< Below center
-      BelowRight SIP_MONKEYPATCH_COMPAT_NAME( QuadrantBelowRight ), //!< BelowRight
+      BelowRight SIP_MONKEYPATCH_COMPAT_NAME( QuadrantBelowRight ), //!< Below right
     };
     Q_ENUM( LabelQuadrantPosition )
 

src/core/qgsmaplayermodel.h

@@ -65,21 +65,21 @@ class CORE_EXPORT QgsMapLayerModel : public QAbstractItemModel
     /**
      * \brief QgsMapLayerModel creates a model to display layers in widgets.
      *
-     * If a specific \a project is not specified then the QgsProject.instance() project will be used to
+     * If \a project is not specified then the QgsProject.instance() project will be used to
      * populate the model.
      */
     explicit QgsMapLayerModel( QObject *parent SIP_TRANSFERTHIS = nullptr, QgsProject *project = nullptr );
 
     /**
      * \brief QgsMapLayerModel creates a model to display a specific list of layers in a widget.
      *
-     * If a specific \a project is not specified then the QgsProject.instance() project will be used to
+     * If \a project is not specified then the QgsProject.instance() project will be used to
      * populate the model.
      */
     explicit QgsMapLayerModel( const QList<QgsMapLayer *> &layers, QObject *parent = nullptr, QgsProject *project = nullptr );
 
     /**
-     * \brief setItemsCheckable defines if layers should be selectable in the widget
+     * \brief Defines if layers should be selectable in the widget
      */
     void setItemsCheckable( bool checkable );
 
@@ -139,7 +139,7 @@ class CORE_EXPORT QgsMapLayerModel : public QAbstractItemModel
     bool showCrs() const { return mShowCrs; }
 
     /**
-     * \brief layersChecked returns the list of layers which are checked (or unchecked)
+     * \brief Returns the list of layers which are checked (or unchecked)
      */
     QList<QgsMapLayer *> layersChecked( Qt::CheckState checkState = Qt::Checked );
 
@@ -148,7 +148,7 @@ class CORE_EXPORT QgsMapLayerModel : public QAbstractItemModel
      */
     void setLayersChecked( const QList< QgsMapLayer * > &layers );
 
-    //! returns if the items can be checked or not
+    //! Returns if the items can be checked or not
     bool itemsCheckable() const { return mItemCheckable; }
 
     /**

src/gui/qgsmapcanvas.h

@@ -535,30 +535,36 @@ class GUI_EXPORT QgsMapCanvas : public QGraphicsView, public QgsExpressionContex
 #endif
 
     /**
-     * Freeze/thaw the map canvas. This is used to prevent the canvas from
+     * Freezes/thaws the map canvas. This is used to prevent the canvas from
      * responding to events while layers are being added/removed etc.
      * \param frozen Boolean specifying if the canvas should be frozen (TRUE) or
      * thawed (FALSE). Default is TRUE.
      * \see isFrozen()
-     * \see setRenderFlag(). freeze() should be used to programmatically halt map updates,
+     * \see setRenderFlag()
+     *
+     * \note freeze() should be used to programmatically halt map updates,
      * while setRenderFlag() should only be used when users disable rendering via GUI.
      */
     void freeze( bool frozen = true );
 
     /**
      * Returns TRUE if canvas is frozen.
-     * \see renderFlag(). isFrozen() should be used to determine whether map updates
+     * \see freeze()
+     * \see renderFlag()
+     *
+     * \note isFrozen() should be used to determine whether map updates
      * have been halted programmatically, while renderFlag() should be used to
      * determine whether a user has disabled rendering via GUI.
-     * \see freeze()
      */
     bool isFrozen() const;
 
     /**
      * Returns TRUE if canvas render is disabled as a result of user disabling
      * renders via the GUI.
      * \see setRenderFlag()
-     * \see isFrozen(). isFrozen() should be used to determine whether map updates
+     * \see isFrozen()
+     *
+     * \note isFrozen() should be used to determine whether map updates
      * have been halted programmatically, while renderFlag() should be used to
      * determine whether a user has disabled rendering via GUI.
      */
@@ -938,7 +944,9 @@ class GUI_EXPORT QgsMapCanvas : public QGraphicsView, public QgsExpressionContex
      * Sets whether a user has disabled canvas renders via the GUI.
      * \param flag set to FALSE to indicate that user has disabled renders
      * \see renderFlag()
-     * \see freeze(). freeze() should be used to programmatically halt map updates,
+     * \see freeze()
+     *
+     * \note freeze() should be used to programmatically halt map updates,
      * while setRenderFlag() should only be used when users disable rendering via GUI.
      */
     void setRenderFlag( bool flag );