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

doc: Use lowercase for 2D raster mask #4401

Merged
merged 3 commits into from
Oct 11, 2024
Merged

Conversation

wenzeslaus
Copy link
Member

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.

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 github-actions bot added raster Related to raster data processing C Related code is in C HTML Related code is in HTML module docs display raster3d labels Sep 27, 2024
raster/r.external/r.external.html Outdated Show resolved Hide resolved
raster/r.null/r.null.html Outdated Show resolved Hide resolved
wenzeslaus and others added 2 commits October 11, 2024 08:57
Co-authored-by: Anna Petrasova <kratochanna@gmail.com>
@wenzeslaus wenzeslaus merged commit b9a6b68 into OSGeo:main Oct 11, 2024
26 checks passed
@wenzeslaus wenzeslaus deleted the mask-not-MASK branch October 11, 2024 14:21
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
Again, use lowercase mask and other wording instead of MASK when talking about masking, similar to #4401 and #4495.

It also adjusts the wording in r.topidx and i.segment.
@neteler neteler added this to the 8.5.0 milestone Oct 17, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
C Related code is in C display docs HTML Related code is in HTML module raster Related to raster data processing raster3d
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants