Merge pull request #43368 from DelazJ/temporalTypos

Fix typos in temporal docs
qgis · May 25, 2021 · b8fe026 · b8fe026
1 parent c0e15c0
commit b8fe026
Show file tree

Hide file tree

Showing 4 changed files with 13 additions and 12 deletions.
diff --git a/python/core/auto_generated/qgstemporalnavigationobject.sip.in b/python/core/auto_generated/qgstemporalnavigationobject.sip.in
@@ -67,7 +67,7 @@ Sets the temporal navigation ``mode``.
 
     NavigationMode navigationMode() const;
 %Docstring
-Returns the currenttemporal navigation mode.
+Returns the current temporal navigation mode.
 
 .. seealso:: :py:func:`setNavigationMode`
 %End
@@ -120,8 +120,8 @@ which together describe the complete range of times which contain data.
 %Docstring
 Sets the current animation ``frame`` number.
 
-Caling this method will change the controllers current datetime range to match, based on the
-:py:func:`~QgsTemporalNavigationObject.temporalExtents` and :py:func:`~QgsTemporalNavigationObject.frameDuration` values.
+Calling this method will change the controllers current datetime range to match,
+based on the :py:func:`~QgsTemporalNavigationObject.temporalExtents` and :py:func:`~QgsTemporalNavigationObject.frameDuration` values.
 
 .. seealso:: :py:func:`currentFrameNumber`
 %End

diff --git a/python/gui/auto_generated/qgsmapcanvas.sip.in b/python/gui/auto_generated/qgsmapcanvas.sip.in
@@ -78,8 +78,9 @@ Gets access to properties used for map rendering
 
     void setTemporalController( QgsTemporalController *controller );
 %Docstring
-Sets the temporal controller, tQgsMapCanvasInteractionBlockerhis controller will be used to
-update the canvas temporal range.
+Sets the temporal ``controller`` for this canvas.
+
+The controller will be used to update the canvas' temporal range.
 
 .. versionadded:: 3.14
 %End
@@ -94,7 +95,7 @@ update the canvas temporal range.
 
     void setDestinationCrs( const QgsCoordinateReferenceSystem &crs );
 %Docstring
-sets destination coordinate reference system
+Sets destination coordinate reference system
 
 .. versionadded:: 2.4
 %End

diff --git a/src/core/qgstemporalnavigationobject.h b/src/core/qgstemporalnavigationobject.h
@@ -85,7 +85,7 @@ class CORE_EXPORT QgsTemporalNavigationObject : public QgsTemporalController, pu
     void setNavigationMode( const NavigationMode mode );
 
     /**
-     * Returns the currenttemporal navigation mode.
+     * Returns the current temporal navigation mode.
      *
      * \see setNavigationMode()
      */
@@ -134,8 +134,8 @@ class CORE_EXPORT QgsTemporalNavigationObject : public QgsTemporalController, pu
     /**
      * Sets the current animation \a frame number.
      *
-     * Caling this method will change the controllers current datetime range to match, based on the
-     * temporalExtents() and frameDuration() values.
+     * Calling this method will change the controllers current datetime range to match,
+     * based on the temporalExtents() and frameDuration() values.
      *
      * \see currentFrameNumber()
      */

diff --git a/src/gui/qgsmapcanvas.h b/src/gui/qgsmapcanvas.h
@@ -133,9 +133,9 @@ class GUI_EXPORT QgsMapCanvas : public QGraphicsView, public QgsExpressionContex
     const QgsMapSettings &mapSettings() const SIP_KEEPREFERENCE;
 
     /**
-     * Sets the temporal controller, tQgsMapCanvasInteractionBlockerhis controller will be used to
-     * update the canvas temporal range.
+     * Sets the temporal \a controller for this canvas.
      *
+     * The controller will be used to update the canvas' temporal range.
      * \since QGIS 3.14
      */
     void setTemporalController( QgsTemporalController *controller );
@@ -149,7 +149,7 @@ class GUI_EXPORT QgsMapCanvas : public QGraphicsView, public QgsExpressionContex
     const QgsTemporalController *temporalController() const;
 
     /**
-     * sets destination coordinate reference system
+     * Sets destination coordinate reference system
      * \since QGIS 2.4
      */
     void setDestinationCrs( const QgsCoordinateReferenceSystem &crs );