Merge pull request #46493 from suricactus/fix_misleading_docs

Fix misleading docs that is only valid if edit buffer is used (so does not work in transaction mode)
qgis · Dec 15, 2021 · fab5d8a · fab5d8a
2 parents 68a1470 + 527359b
commit fab5d8a
Show file tree

Hide file tree

Showing 2 changed files with 12 additions and 12 deletions.
diff --git a/python/core/auto_generated/vector/qgsvectorlayer.sip.in b/python/core/auto_generated/vector/qgsvectorlayer.sip.in
@@ -2891,27 +2891,27 @@ Note that at this point the geometry change is not yet saved to the provider.
 
     void committedAttributesDeleted( const QString &layerId, const QgsAttributeList &deletedAttributes );
 %Docstring
-Emitted when attributes are deleted from the provider
+Emitted when attributes are deleted from the provider if not in transaction mode.
 %End
     void committedAttributesAdded( const QString &layerId, const QList<QgsField> &addedAttributes );
 %Docstring
-Emitted when attributes are added to the provider
+Emitted when attributes are added to the provider if not in transaction mode.
 %End
     void committedFeaturesAdded( const QString &layerId, const QgsFeatureList &addedFeatures );
 %Docstring
-Emitted when features are added to the provider
+Emitted when features are added to the provider if not in transaction mode.
 %End
     void committedFeaturesRemoved( const QString &layerId, const QgsFeatureIds &deletedFeatureIds );
 %Docstring
-Emitted when features are deleted from the provider
+Emitted when features are deleted from the provider if not in transaction mode.
 %End
     void committedAttributeValuesChanges( const QString &layerId, const QgsChangedAttributesMap &changedAttributesValues );
 %Docstring
-Emitted when attribute value changes are saved to the provider
+Emitted when attribute value changes are saved to the provider if not in transaction mode.
 %End
     void committedGeometriesChanges( const QString &layerId, const QgsGeometryMap &changedGeometries );
 %Docstring
-Emitted when geometry changes are saved to the provider
+Emitted when geometry changes are saved to the provider if not in transaction mode.
 %End
 
     void labelingFontNotFound( QgsVectorLayer *layer, const QString &fontfamily );

diff --git a/src/core/vector/qgsvectorlayer.h b/src/core/vector/qgsvectorlayer.h
@@ -2680,17 +2680,17 @@ class CORE_EXPORT QgsVectorLayer : public QgsMapLayer, public QgsExpressionConte
      */
     void geometryChanged( QgsFeatureId fid, const QgsGeometry &geometry );
 
-    //! Emitted when attributes are deleted from the provider
+    //! Emitted when attributes are deleted from the provider if not in transaction mode.
     void committedAttributesDeleted( const QString &layerId, const QgsAttributeList &deletedAttributes );
-    //! Emitted when attributes are added to the provider
+    //! Emitted when attributes are added to the provider if not in transaction mode.
     void committedAttributesAdded( const QString &layerId, const QList<QgsField> &addedAttributes );
-    //! Emitted when features are added to the provider
+    //! Emitted when features are added to the provider if not in transaction mode.
     void committedFeaturesAdded( const QString &layerId, const QgsFeatureList &addedFeatures );
-    //! Emitted when features are deleted from the provider
+    //! Emitted when features are deleted from the provider if not in transaction mode.
     void committedFeaturesRemoved( const QString &layerId, const QgsFeatureIds &deletedFeatureIds );
-    //! Emitted when attribute value changes are saved to the provider
+    //! Emitted when attribute value changes are saved to the provider if not in transaction mode.
     void committedAttributeValuesChanges( const QString &layerId, const QgsChangedAttributesMap &changedAttributesValues );
-    //! Emitted when geometry changes are saved to the provider
+    //! Emitted when geometry changes are saved to the provider if not in transaction mode.
     void committedGeometriesChanges( const QString &layerId, const QgsGeometryMap &changedGeometries );
 
     //! Emitted when the font family defined for labeling layer is not found on system