Merge pull request #51102 from DelazJ/createMapRendererV2

Correctly render ordered list in maplayerrenderer API docs - take 2
qgis · Dec 9, 2022 · 4ee8225 · 4ee8225
2 parents 36b4bc8 + ef232d5
commit 4ee8225
Show file tree

Hide file tree

Showing 2 changed files with 8 additions and 14 deletions.
diff --git a/python/core/auto_generated/qgsmaplayerrenderer.sip.in b/python/core/auto_generated/qgsmaplayerrenderer.sip.in
@@ -27,13 +27,10 @@ Qt containers and various Qt classes use implicit sharing.
 
 The scenario will be:
 
-#. renderer job (doing preparation in the GUI thread) calls
-  :py:func:`QgsMapLayer.createMapRenderer()` and gets instance of this class.
-  The instance is initialized at that point and should not need
-  additional calls to :py:class:`QgsVectorLayer`.
-#. renderer job (still in GUI thread) stores the renderer for later use.
-#. renderer job (in worker thread) calls :py:func:`QgsMapLayerRenderer.render()`
-#. renderer job (again in GUI thread) will check :py:func:`~errors` and report them
+1. renderer job (doing preparation in the GUI thread) calls :py:func:`QgsMapLayer.createMapRenderer()` and gets instance of this class. The instance is initialized at that point and should not need additional calls to :py:class:`QgsVectorLayer`.
+2. renderer job (still in GUI thread) stores the renderer for later use.
+3. renderer job (in worker thread) calls :py:func:`QgsMapLayerRenderer.render()`
+4. renderer job (again in GUI thread) will check :py:func:`~errors` and report them
 
 .. versionadded:: 2.4
 %End

diff --git a/src/core/qgsmaplayerrenderer.h b/src/core/qgsmaplayerrenderer.h
@@ -41,13 +41,10 @@ class QgsRenderedItemDetails;
  *
  * The scenario will be:
  *
- * #. renderer job (doing preparation in the GUI thread) calls
- *    QgsMapLayer::createMapRenderer() and gets instance of this class.
- *    The instance is initialized at that point and should not need
- *    additional calls to QgsVectorLayer.
- * #. renderer job (still in GUI thread) stores the renderer for later use.
- * #. renderer job (in worker thread) calls QgsMapLayerRenderer::render()
- * #. renderer job (again in GUI thread) will check errors() and report them
+ * 1. renderer job (doing preparation in the GUI thread) calls QgsMapLayer::createMapRenderer() and gets instance of this class. The instance is initialized at that point and should not need additional calls to QgsVectorLayer.
+ * 2. renderer job (still in GUI thread) stores the renderer for later use.
+ * 3. renderer job (in worker thread) calls QgsMapLayerRenderer::render()
+ * 4. renderer job (again in GUI thread) will check errors() and report them
  *
  * \since QGIS 2.4
  */