Improve docs

qgis · Nov 2, 2019 · 8797798 · 8797798
1 parent b628244
commit 8797798
Show file tree

Hide file tree

Showing 2 changed files with 17 additions and 0 deletions.
diff --git a/python/core/auto_generated/qgsdataprovider.sip.in b/python/core/auto_generated/qgsdataprovider.sip.in
@@ -391,6 +391,17 @@ Returns ``True`` if metadata was successfully written to the data provider.
 
 
     static QString sublayerSeparator();
+%Docstring
+String sequence used for separating components of sublayers strings.
+
+.. note::
+
+   Replaces the static const SUBLAYER_SEPARATOR
+
+.. seealso:: :py:func:`subLayers`
+
+.. versionadded:: 3.12
+%End
 
   signals:
 

diff --git a/src/core/qgsdataprovider.h b/src/core/qgsdataprovider.h
@@ -539,6 +539,12 @@ class CORE_EXPORT QgsDataProvider : public QObject
      */
     virtual void setTransformContext( const QgsCoordinateTransformContext &transformContext ) SIP_SKIP;
 
+    /**
+     * String sequence used for separating components of sublayers strings.
+     * \note Replaces the static const SUBLAYER_SEPARATOR
+     * \see subLayers()
+     * \since QGIS 3.12
+     */
     static QString sublayerSeparator();
 
   signals: