improve docs

qgis · Dec 13, 2019 · b89f1e0 · b89f1e0
1 parent d788d0f
commit b89f1e0
Show file tree

Hide file tree

Showing 4 changed files with 6 additions and 13 deletions.
diff --git a/python/core/auto_generated/qgsdataprovider.sip.in b/python/core/auto_generated/qgsdataprovider.sip.in
@@ -267,7 +267,8 @@ databases and servers.
 %Docstring
 Reloads the data from the source by calling reloadProviderData() implemented
 by providers with data caches to synchronize, changes in the data source, feature
-counts and other specific actions and it calls the dataChanged signal
+counts and other specific actions.
+Emits the `dataChanged` signal
 
 .. seealso:: :py:func:`reloadProviderData`
 %End

diff --git a/python/core/auto_generated/qgsvectordataprovider.sip.in b/python/core/auto_generated/qgsvectordataprovider.sip.in
@@ -548,11 +548,6 @@ Returns the transaction this data provider is included in, if any.
 
  virtual void forceReload() /Deprecated/;
 %Docstring
-Forces a reload of the underlying datasource if the provider implements this
-method.
-In particular on the OGR provider, a pooled connection will be invalidated.
-This forces QGIS to reopen a file or connection.
-This can be required if the underlying file is replaced.
 
 .. deprecated::
    QGIS 3.12 - will be removed in QGIS 4.0 - use reloadData instead

diff --git a/src/core/qgsdataprovider.h b/src/core/qgsdataprovider.h
@@ -358,7 +358,8 @@ class CORE_EXPORT QgsDataProvider : public QObject
     /**
      * Reloads the data from the source by calling reloadProviderData() implemented
      * by providers with data caches to synchronize, changes in the data source, feature
-     * counts and other specific actions and it calls the dataChanged signal
+     * counts and other specific actions.
+     * Emits the `dataChanged` signal
      * \see reloadProviderData()
      */
     virtual void reloadData();
@@ -618,6 +619,7 @@ class CORE_EXPORT QgsDataProvider : public QObject
 
     /**
      * Reloads the data according to the provider
+     * \since QGIS 3.12
     */
     virtual void reloadProviderData() {}
 };

diff --git a/src/core/qgsvectordataprovider.h b/src/core/qgsvectordataprovider.h
@@ -549,13 +549,8 @@ class CORE_EXPORT QgsVectorDataProvider : public QgsDataProvider, public QgsFeat
     virtual QgsTransaction *transaction() const;
 
     /**
-     * Forces a reload of the underlying datasource if the provider implements this
-     * method.
-     * In particular on the OGR provider, a pooled connection will be invalidated.
-     * This forces QGIS to reopen a file or connection.
-     * This can be required if the underlying file is replaced.
      * \deprecated QGIS 3.12 - will be removed in QGIS 4.0 - use reloadData instead
-    */
+     */
     Q_DECL_DEPRECATED virtual void forceReload() SIP_DEPRECATED { reloadData(); }
 
     /**