QgsFeature::setId improve documentation with a warning. fixes #44898

qgis · Sep 22, 2021 · 7dc1338 · 7dc1338
1 parent 83f3927
commit 7dc1338
Show file tree

Hide file tree

Showing 2 changed files with 10 additions and 1 deletion.
diff --git a/python/core/auto_generated/qgsfeature.sip.in b/python/core/auto_generated/qgsfeature.sip.in
@@ -177,6 +177,12 @@ Sets the feature ID for this feature.
 :param id: feature id
 
 .. seealso:: :py:func:`id`
+
+.. warning::
+
+   Feature IDs will be automatically changed whenever a feature is added to vector layer or data provider.
+   This method is not designed to allow a specific feature ID to be assigned to a feature which will be added to a
+   layer or data provider, and the results will be unpredictable
 %End
 
     QgsAttributes attributes() const;

diff --git a/src/core/qgsfeature.h b/src/core/qgsfeature.h
@@ -224,7 +224,10 @@ class CORE_EXPORT QgsFeature
     /**
      * Sets the feature ID for this feature.
      * \param id feature id
-     * \see id
+     * \see id()
+     * \warning Feature IDs will be automatically changed whenever a feature is added to vector layer or data provider.
+     *  This method is not designed to allow a specific feature ID to be assigned to a feature which will be added to a
+     *  layer or data provider, and the results will be unpredictable
      */
     void setId( QgsFeatureId id );