Extend documentation of QgsFeatureRequest::setSubsetOfAttributes

Like suggested by Nyall
qgis · Oct 19, 2018 · 99f3419 · 99f3419
1 parent 71e85cc
commit 99f3419
Show file tree

Hide file tree

Showing 2 changed files with 8 additions and 0 deletions.
diff --git a/python/core/auto_generated/qgsfeaturerequest.sip.in b/python/core/auto_generated/qgsfeaturerequest.sip.in
@@ -509,6 +509,10 @@ Sets flags that affect how features will be fetched
     QgsFeatureRequest &setSubsetOfAttributes( const QgsAttributeList &attrs );
 %Docstring
 Set a subset of attributes that will be fetched.
+
+An empty attributes list indicates that no attributes will be fetched.
+To revert a call to setSubsetOfAttributes and fetch all available attributes,
+the SubsetOfAttributes flag should be removed from the request.
 %End
 
     QgsAttributeList subsetOfAttributes() const;

diff --git a/src/core/qgsfeaturerequest.h b/src/core/qgsfeaturerequest.h
@@ -494,6 +494,10 @@ class CORE_EXPORT QgsFeatureRequest
 
     /**
      * Set a subset of attributes that will be fetched.
+     *
+     * An empty attributes list indicates that no attributes will be fetched.
+     * To revert a call to setSubsetOfAttributes and fetch all available attributes,
+     * the SubsetOfAttributes flag should be removed from the request.
      */
     QgsFeatureRequest &setSubsetOfAttributes( const QgsAttributeList &attrs );