Skip to content

Comments

doc: Use lowercase for 2D raster mask#4401

Merged
wenzeslaus merged 3 commits intoOSGeo:mainfrom
wenzeslaus:mask-not-MASK
Oct 11, 2024
Merged

doc: Use lowercase for 2D raster mask#4401
wenzeslaus merged 3 commits intoOSGeo:mainfrom
wenzeslaus:mask-not-MASK

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
@wenzeslaus wenzeslaus requested a review from petrasovaa October 11, 2024 12:58
@wenzeslaus wenzeslaus merged commit b9a6b68 into OSGeo:main Oct 11, 2024
@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
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
Similarly to #4401 and #4495, this replaces usage of MASK by mask or raster mask. It removes uppercase MASK when not needed.
wenzeslaus added a commit that referenced this pull request Jan 29, 2025
Similarly to #4401, #4495, and #5000 this replaces usage of MASK by (raster) mask. This should be the last one or close to last one which does the cosmetics of MASK to mask switch.
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