Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Show notes for algs which regenerate primary keys #58100

Merged
merged 7 commits into from
Jul 15, 2024

Conversation

nyalldawson
Copy link
Collaborator

Add a new Qgis::ProcessingAlgorithmDocumentationFlag flag, with a virtual method in QgsProcessingAlgorithm to return documentation flags. These flags are used to indicate algorithm behavior which should be noted in the documentation.

Add initial flags for algorithms which drop and regenerate primary keys/FIDs, and automatically add a note to the algorithm's help panel to explain that this will occur

In future this flag could be extended with other helpful warnings, eg

  • Algorithm requires valid geometries (ping @lbartoletti -- this relates to discussion on a earlier PR from last week)
  • Algorithm will segmentize curved geometries
  • Algorithm will drop Z or M values

image

Add a new Qgis::ProcessingAlgorithmDocumentationFlag flag, with
a virtual method in QgsProcessingAlgorithm to return documentation
flags. These flags are used to indicate algorithm behavior which
should be noted in the documentation.

Add initial flags for algorithms which drop and regenerate
primary keys/FIDs, and automatically add a note to the algorithm's
help panel to explain that this will occur

In future this flag could be extended with other helpful warnings,
eg

- Algorithm requires valid geometries
- Algorithm will segmentize curved geometries
- Algorithm will drop Z or M values
@nyalldawson nyalldawson added the Processing Relating to QGIS Processing framework or individual Processing algorithms label Jul 14, 2024
@github-actions github-actions bot added this to the 3.40.0 milestone Jul 14, 2024
Copy link

github-actions bot commented Jul 14, 2024

🪟 Windows builds ready!

Windows builds of this PR are available for testing here. Debug symbols for this build are available here.

(Built from commit 8586202)

@nyalldawson
Copy link
Collaborator Author

Another potential flag would be "uses ellipsoidal calculations for area/length measurements"

Copy link
Member

@lbartoletti lbartoletti left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Good idea, thanks!

@nyalldawson nyalldawson merged commit ad03718 into qgis:master Jul 15, 2024
30 checks passed
@nyalldawson nyalldawson deleted the processing_doc branch July 15, 2024 22:06
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Processing Relating to QGIS Processing framework or individual Processing algorithms
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants