sharpetronics/QGIS
1
0
Fork 0
mirror of https://github.com/qgis/QGIS.git synced 2025-12-04 00:06:46 -05:00
Code Issues Packages Projects Releases Wiki Activity

Cleaner docs

Browse Source
This commit is contained in:
Nyall Dawson 2022-08-23 10:07:54 +10:00
parent 67bdadfead
commit b79ca2951f
2 changed files with 12 additions and 4 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

12
python/core/auto_generated/project/qgsproject.sip.in
View File

@ -2123,13 +2123,15 @@ that the user has some chance of repairing the damage cleanly.
:param vectorLayer: for which the changes will be committed. For buffered transactions this
parameter is not mandatory, as the changes from all layers will be committed.
:return: - ``True`` if the commit was successful.
- commitErrors: will be set to a list of descriptive errors if the commit fails.
.. seealso:: :py:func:`startEditing`
.. seealso:: :py:func:`rollBack`
:return: - commitErrors: will be set to a list of descriptive errors if the commit fails.
.. versionadded:: 3.26
%End
@ -2142,13 +2144,15 @@ Stops a current editing operation on vectorLayer and discards any uncommitted ed
:param vectorLayer: for which the changes will be rolled back. For buffered transactions this
parameter is not mandatory, as the changes from all layers will be rolled back.
:return: - ``True`` if the rollback was successful.
- rollbackErrors: will be set to a list of descriptive errors if the rollback fails.
.. seealso:: :py:func:`startEditing`
.. seealso:: :py:func:`commitChanges`
:return: - rollbackErrors: will be set to a list of descriptive errors if the rollback fails.
.. versionadded:: 3.26
%End

4
src/core/project/qgsproject.h
View File

@ -2086,6 +2086,8 @@ class CORE_EXPORT QgsProject : public QObject, public QgsExpressionContextGenera
* \param vectorLayer for which the changes will be committed. For buffered transactions this
* parameter is not mandatory, as the changes from all layers will be committed.
*
* \returns TRUE if the commit was successful.
*
* \see startEditing()
* \see rollBack()
*
@ -2102,6 +2104,8 @@ class CORE_EXPORT QgsProject : public QObject, public QgsExpressionContextGenera
* \param vectorLayer for which the changes will be rolled back. For buffered transactions this
* parameter is not mandatory, as the changes from all layers will be rolled back.
*
* \returns TRUE if the rollback was successful.
*
* \see startEditing()
* \see commitChanges()
*