v.clean: Change threshold description to clarify map units#2950
v.clean: Change threshold description to clarify map units#2950neteler merged 3 commits intoOSGeo:mainfrom neteler:v_clean_threshold_description
Conversation
This PR de-confuses the current description of `threshold` from the misleading ``` threshold Threshold in map units, one value for each tool ``` to ``` threshold One value for each tool; for threshold units, see each tool ``` The point is that users need to look it up in the manual page. Esp. in long-lat locations, map units for area based tools are to be given in sqm.
|
The manual would need adjustment: either explain threshold in general: map units with the exception of |
Personally, I'd prefer going the long route, and have an explanation in each tool in the manual, or at least to refer to a common page at each tool. Since when using a tool, you'd be using the docs of the tool you are using, not the other ones or global docs (imagine the documentation section in the user interface tab when using the tool) |
wenzeslaus
left a comment
wenzeslaus
left a comment
There was a problem hiding this comment.
The label is improved without creating any negative side effects. The documentation of the v.clean tool already mentions units for at least some of its tools. Let's merge this as is.
|
@neteler Please consider merging this PR. |
* v.clean threshold description: clarify map units This PR de-confuses the current description of `threshold` from the misleading ``` threshold Threshold in map units, one value for each tool ``` to ``` threshold One value for each tool; for threshold units, see each tool ``` The point is that users need to look it up in the manual page. Esp. in long-lat locations, map units for area based tools are to be given in sqm.
* v.clean threshold description: clarify map units This PR de-confuses the current description of `threshold` from the misleading ``` threshold Threshold in map units, one value for each tool ``` to ``` threshold One value for each tool; for threshold units, see each tool ``` The point is that users need to look it up in the manual page. Esp. in long-lat locations, map units for area based tools are to be given in sqm.
wenzeslaus
changed the title
5 participants
This PR de-confuses the current description of
thresholdfrom the misleadingto
The point is that users need to look it up in the manual page. Esp. in long-lat locations, map units for area based tools are to be given in sqm, see https://grass.osgeo.org/grass-stable/manuals/v.clean.html