Align in-place documentation #9926
Open
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
To be available for in-place editing, processing algorithms implement the `bool supportInPlaceEdit(…)`-method. As this is not dependent on the algorithms only working on feature source level or not modifying fields, but stands on its own, it might make it easier for users if we communicate what these algorithms do, not why or why not they are available.
koebi
added a commit
to koebi/QGIS-Documentation
that referenced
this pull request
Jun 4, 2025
This is superseded by qgis#9926
DelazJ
reviewed
Jun 10, 2025
Collaborator
DelazJ
left a comment
DelazJ
left a comment
There was a problem hiding this comment.
Thanks @koebi
The old description tried to (maybe incorrectly) explain the list of remaining algorithms i.e., what makes an algorithm eligible to in-place editing. If I understand clearly, this PR tries to explain how an algorithm works in in-place editing context. I don't think both are incompatible or one should replace the other. Is that not possible to have both?
| layer level. It does not change the layer structure, e.g. adding or removing | ||
| fields. Algorithms that usually work on layer level, e.g. ``Reproject | ||
| layer`` or add fields, e.g. ``Orientated minimum bounding boxes`` will not | ||
| do so when editing features in-place. |
Collaborator
There was a problem hiding this comment.
It is unclear to me what the "Reproject layer" alg will not do.
|
|
||
| * They work at the feature source and not at the layer level. | ||
| * They do not change the layer structure, e.g. adding or removing fields. | ||
| * They do not change the geometry type, e.g. from line to point layer. |
Collaborator
There was a problem hiding this comment.
The info about geometry type is removed. Does it mean that it is now possible to change geometry type of features?
Comment on lines
+2170
to
+2171
| fields. Algorithms that usually work on layer level, e.g. ``Reproject | ||
| layer`` or add fields, e.g. ``Orientated minimum bounding boxes`` will not |
Collaborator
There was a problem hiding this comment.
Suggested change
| fields. Algorithms that usually work on layer level, e.g. ``Reproject | |
| layer`` or add fields, e.g. ``Orientated minimum bounding boxes`` will not | |
| fields. Algorithms that usually work on layer level (e.g., ``Reproject | |
| layer``) or add fields (e.g., ``Oriented minimum bounding box``) will not |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Goal:
The former documentation and the existing implementation do not align.
This change aims to clear that up and make it more transparent to users what the algorithms do if they are used in-place.