doc: Use lowercase for 2D raster mask #4401
Merged
Conversation
This file contains 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
On many places (more than covered here), 2D raster mask is called MASK conflating the concept (mask) and the implementation (MASK raster). Users using the r.mask tool may not interact with the underlying raster directly, so there is no reason to use MASK over mask. This is leaving many places as they are with MASK. Some will be better revisited with or after OSGeo#2390 and OSGeo#2392 when a more comprehensive solution is available. This fixes and keeps in sync wording r.null and r.external, and moves r.circle comment documenting the interface to a flag description.
github-actions
bot
added
raster
petrasovaa
requested changes
Oct 2, 2024
Co-authored-by: Anna Petrasova <[email protected]>
petrasovaa
approved these changes
Oct 11, 2024
wenzeslaus
added a commit
that referenced
this pull request
Oct 15, 2024
Similarly to #4401, this replaces usage of MASK by mask on additional places. It also improves wording of a warning in i.fft.
wenzeslaus
added a commit
that referenced
this pull request
Oct 15, 2024
wenzeslaus
added a commit
to wenzeslaus/grass
that referenced
this pull request
Jan 27, 2025
Similarly to OSGeo#4401 and OSGeo#4495, this replaces usage of MASK by mask or raster mask. It removes uppercase MASK when not needed.
petrasovaa
pushed a commit
that referenced
this pull request
Jan 28, 2025
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
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.
On many places (more than covered here), 2D raster mask is called MASK conflating the concept (mask) and the implementation (MASK raster). Users using the r.mask tool may not interact with the underlying raster directly, so there is no reason to use MASK over mask.
This is leaving many places as they are with MASK. Some will be better revisited with or after #2390 and #2392 when a more comprehensive solution is available.
This fixes and keeps in sync wording r.null and r.external, and moves r.circle comment documenting the interface to a flag description.