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

v.clean: Change threshold description to clarify map units #2950

Merged
merged 3 commits into from
Nov 20, 2023

Conversation

neteler
Copy link
Member

@neteler neteler commented May 8, 2023

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, see https://grass.osgeo.org/grass-stable/manuals/v.clean.html

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.
@neteler neteler added backport_needed manual Documentation related issues labels May 8, 2023
@neteler neteler self-assigned this May 8, 2023
@metzm
Copy link
Contributor

metzm commented May 8, 2023

The manual would need adjustment: either explain threshold in general: map units with the exception of tool=rmarea where units are always squaremeter, or add an explanation of the threshold to each tool in the manual.

@echoix
Copy link
Member

echoix commented May 8, 2023

The manual would need adjustment: either explain threshold in general: map units with the exception of tool=rmarea where units are always squaremeter, or add an explanation of the threshold to each tool in the manual.

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)

@landam landam added this to the 8.4.0 milestone Jun 6, 2023
Copy link
Member

@wenzeslaus wenzeslaus left a comment

Choose a reason for hiding this comment

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

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.

@landam
Copy link
Member

landam commented Nov 19, 2023

@neteler Please consider merging this PR.

@neteler neteler merged commit fb083e1 into OSGeo:main Nov 20, 2023
18 checks passed
@neteler neteler deleted the v_clean_threshold_description branch November 20, 2023 07:52
neteler added a commit that referenced this pull request Nov 20, 2023
* 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.
@neteler neteler modified the milestones: 8.4.0, 8.3.2 Dec 17, 2023
HuidaeCho pushed a commit to HuidaeCho/grass that referenced this pull request Jan 9, 2024
* 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 wenzeslaus changed the title v.clean threshold description: clarify map units v.clean: Change threshold description to clarify map units Jun 14, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
manual Documentation related issues
Projects
None yet
Development

Successfully merging this pull request may close these issues.

5 participants