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: fix typo and add bold weight to first mention of important terms in r.geomorphon manual page #4831

Open
wants to merge 3 commits into
base: main
Choose a base branch
from

Conversation

gregorywaynepower
Copy link
Contributor

@gregorywaynepower gregorywaynepower commented Dec 11, 2024

  • Adds bolding around the first mention of search radius (L) and relief threshold (d) since the variables are referenced later on in the description.
  • Fixes typo in sentence starting with "...There are 3**8 = 6561 possible ternary patterns..."
  • Changes "However by eliminating all patterns that are results of either rotation or reflection of other patterns wa set of 498 patterns remain referred as geomorphons. This is a comprehensive and exhaustive set of idealized landforms that are independent of the size, relief, and orientation of the actual landform." to "However by eliminating all patterns that are results of either rotation or reflection of other patterns we get a set of 498 patterns remain referred as geomorphons. This is a comprehensive and exhaustive set of idealized landforms that are independent of the size, relief, and orientation of the actual landform."

@github-actions github-actions bot added raster Related to raster data processing HTML Related code is in HTML module docs labels Dec 11, 2024
@gregorywaynepower gregorywaynepower changed the title fix typo and add bold weight to first mention of important terms r.geomorphon docs: fix typo and add bold weight to first mention of important terms Dec 11, 2024
veroandreo
veroandreo previously approved these changes Dec 15, 2024
Copy link
Contributor

@veroandreo veroandreo left a comment

Choose a reason for hiding this comment

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

Thanks!

@@ -23,7 +23,7 @@ <h3>What is geomorphon:</h3>
nadir angles along the eight principal compass directions. The ternary
operator converts the information contained in all the pairs of zenith and
nadir angles into the ternary pattern (8-tuple). The result depends on the
values of two parameters: search radius (L) and relief threshold (d). The
values of two parameters: <b>search radius (L)</b> and <b>relief threshold (d)</b>. The
Copy link
Member

Choose a reason for hiding this comment

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

I am not sure about this suggestion:

  • search exists as a parameter
  • relief does not (I checked also old module versions, back to GRASS GIS 7.6).

Looking at the paper (https://www.geomorphometry.org/uploads/pdf/pdf2011/StepinskiJasiewicz2011geomorphometry.pdf) I am not sure if and how the wording needs to be updated.

Maybe @metzm can enlighten us here?

Copy link
Contributor

Choose a reason for hiding this comment

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

Is it possible that relief threshold in the text refers to the flat parameter?

Copy link
Contributor Author

Choose a reason for hiding this comment

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

I have no problems with reverting the bolding change.

@veroandreo veroandreo changed the title r.geomorphon docs: fix typo and add bold weight to first mention of important terms doc: fix typo and add bold weight to first mention of important terms in r.geomorphon manual page Dec 15, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
docs HTML Related code is in HTML module raster Related to raster data processing
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants