Fix docstring for setEditFormConfig

qgis · May 23, 2018 · f41daee · f41daee
1 parent 45aca2f
commit f41daee
Show file tree

Hide file tree

Showing 2 changed files with 4 additions and 7 deletions.
diff --git a/python/core/auto_generated/qgsvectorlayer.sip.in b/python/core/auto_generated/qgsvectorlayer.sip.in
@@ -2143,10 +2143,9 @@ This is a writable configuration that can directly be changed in place.
 
     void setEditFormConfig( const QgsEditFormConfig &editFormConfig );
 %Docstring
-Get the configuration of the form used to represent this vector layer.
-This is a writable configuration that can directly be changed in place.
+Set the ``editFormConfig`` (configuration) of the form used to represent this vector layer.
 
-:return: The configuration of this layers' form
+.. seealso:: :py:func:`editFormConfig`
 
 .. versionadded:: 3.0
 %End

diff --git a/src/core/qgsvectorlayer.h b/src/core/qgsvectorlayer.h
@@ -1924,11 +1924,9 @@ class CORE_EXPORT QgsVectorLayer : public QgsMapLayer, public QgsExpressionConte
     QgsEditFormConfig editFormConfig() const;
 
     /**
-     * Get the configuration of the form used to represent this vector layer.
-     * This is a writable configuration that can directly be changed in place.
-     *
-     * \returns The configuration of this layers' form
+     * Set the \a editFormConfig (configuration) of the form used to represent this vector layer.
      *
+     * \see editFormConfig()
      * \since QGIS 3.0
      */
     void setEditFormConfig( const QgsEditFormConfig &editFormConfig );