Correctly render qgsMapRendererJob use case steps in docs

qgis · Sep 1, 2020 · a7bf220 · a7bf220
1 parent 97b56fe
commit a7bf220
Show file tree

Hide file tree

Showing 2 changed files with 10 additions and 10 deletions.
diff --git a/python/core/auto_generated/qgsmaprendererjob.sip.in b/python/core/auto_generated/qgsmaprendererjob.sip.in
@@ -25,11 +25,11 @@ amount of time.
 
 Common use case:
 
-# prepare QgsMapSettings with rendering configuration (extent, layer, map size, ...)
-# create QgsMapRendererJob subclass with QgsMapSettings instance
-# connect to job's :py:func:`~finished` signal
-# call :py:func:`~start`. Map rendering will start in background, the function immediately returns
-# at some point, slot connected to :py:func:`~finished` signal is called, map rendering is done
+1. Prepare QgsMapSettings with rendering configuration (extent, layer, map size, ...)
+2. Create QgsMapRendererJob subclass with QgsMapSettings instance
+3. Connect to job's :py:func:`~finished` signal
+4. Call :py:func:`~start`. Map rendering will start in background, the function immediately returns
+5. At some point, slot connected to :py:func:`~finished` signal is called, map rendering is done
 
 It is possible to cancel the rendering job while it is active by calling :py:func:`~cancel` function.
 

diff --git a/src/core/qgsmaprendererjob.h b/src/core/qgsmaprendererjob.h
@@ -167,11 +167,11 @@ struct LabelRenderJob
  *
  * Common use case:
  *
- * # prepare QgsMapSettings with rendering configuration (extent, layer, map size, ...)
- * # create QgsMapRendererJob subclass with QgsMapSettings instance
- * # connect to job's finished() signal
- * # call start(). Map rendering will start in background, the function immediately returns
- * # at some point, slot connected to finished() signal is called, map rendering is done
+ * 1. Prepare QgsMapSettings with rendering configuration (extent, layer, map size, ...)
+ * 2. Create QgsMapRendererJob subclass with QgsMapSettings instance
+ * 3. Connect to job's finished() signal
+ * 4. Call start(). Map rendering will start in background, the function immediately returns
+ * 5. At some point, slot connected to finished() signal is called, map rendering is done
  *
  * It is possible to cancel the rendering job while it is active by calling cancel() function.
  *