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

Fix typos in cylindrical projection examples #2035

Merged
merged 4 commits into from
Aug 3, 2022
Merged

Fix typos in cylindrical projection examples #2035

merged 4 commits into from
Aug 3, 2022

Conversation

yvonnefroehlich
Copy link
Member

Description of proposed changes

This PR aims to fix a few typos in the cylindrical projection examples.


I am not totally sure about the second paragraph of the explanation of the UTM projection, see
https://www.pygmt.org/dev/projections/cyl/cyl_universal_transverse_mercator.html?highlight=10%20away

Maybe it is ... less than 10° away ... in the last line (the unit, probably [the] degree [sign], is missing)?

However, there is also no unit in the equivalent GMT documentation, see
https://docs.generic-mapping-tools.org/dev/cookbook/map-projections.html?highlight=10%20away#universal-transverse-mercator-utm-projection-ju-ju.


Reminders

  • Run make format and make check to make sure the code follows the style guide.
  • Add tests for new features or tests that would have caught the bug that you're fixing.
  • Add new public functions/methods/classes to doc/api/index.rst.
  • Write detailed docstrings for all functions/methods.
  • If wrapping a new module, open a 'Wrap new GMT module' issue and submit reasonably-sized PRs.
  • If adding new functionality, add an example to docstrings or tutorials.

Slash Commands

You can write slash commands (/command) in the first line of a comment to perform
specific operations. Supported slash commands are:

  • /format: automatically format and lint the code
  • /test-gmt-dev: run full tests on the latest GMT development version

@seisman
Copy link
Member

seisman commented Aug 1, 2022

Requesting a review from the original author @willschlitzer (in PR #727).

@seisman seisman added the documentation Improvements or additions to documentation label Aug 1, 2022
@seisman seisman added this to the 0.8.0 milestone Aug 1, 2022
@seisman seisman requested a review from willschlitzer August 1, 2022 07:32
Copy link
Contributor

@willschlitzer willschlitzer left a comment

Choose a reason for hiding this comment

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

Looks good to me!

@seisman
Copy link
Member

seisman commented Aug 2, 2022

Maybe it is ... less than 10° away ... in the last line (the unit, probably [the] degree [sign], is missing)?

However, there is also no unit in the equivalent GMT documentation, see docs.generic-mapping-tools.org/dev/cookbook/map-projections.html?highlight=10%20away#universal-transverse-mercator-utm-projection-ju-ju.

I think your understanding is correct. If you like, please also submit a fix to the upstream GMT repository.

@seisman
Copy link
Member

seisman commented Aug 2, 2022

@yvonnefroehlich I've sent you an invitation to join in the GenericMappingTools/pygmt-contributors. After joining in this team, you will have write permission to the pygmt repository, so you can create branches in the pygmt repository instead of in your own fork.

@seisman
Copy link
Member

seisman commented Aug 2, 2022

I'm looking at the upstream GMT documentation and this example. I think this example can be further improved in the following ways:

  1. The GMT documentation shows this figure, which I believe is very important to know the zone number in the projection setting. So I think we should also include this figure in this example:
    image

  2. Two sentences in the GMT documentation are missing in this example:

    although a standard, you can change this with PROJ_SCALE_FACTOR
    For larger regions we use the conformal latitude in the general spherical formulae instead.

  3. This makes the UTM projection a secant projection and not a tangent projection like the transverse Mercator above.

    "the transverse Mercator above" doesn't make sense in this example. It should be linked to this link https://www.pygmt.org/dev/projections/cyl/cyl_transverse_mercator.html instead.

@yvonnefroehlich
Copy link
Member Author

@yvonnefroehlich I've sent you an invitation to join in the GenericMappingTools/pygmt-contributors.

Thanks for inviting me to the GenericMappingTools organization! 😊 Very happy to joint the pygmt-contributors team! 😊

After joining in this team, you will have write permission to the pygmt repository, so you can create branches in the pygmt repository instead of in your own fork.

This means I finish the already opened PRs via my fork, and for all new PRs I create a branch directly in the PyGMT repro and open a PR from there, correct?

@yvonnefroehlich
Copy link
Member Author

I'm looking at the upstream GMT documentation and this example. I think this example can be further improved in the following ways:

  1. The GMT documentation shows this figure, which I believe is very important to know the zone number in the projection setting. So I think we should also include this figure in this example:

  2. Two sentences in the GMT documentation are missing in this example:

    although a standard, you can change this with PROJ_SCALE_FACTOR
    For larger regions we use the conformal latitude in the general spherical formulae instead.

  3. This makes the UTM projection a secant projection and not a tangent projection like the transverse Mercator above.

    "the transverse Mercator above" doesn't make sense in this example. It should be linked to this link https://www.pygmt.org/dev/projections/cyl/cyl_transverse_mercator.html instead.

I agree with you on all three points. My impression is that the PyGMT documentation for the projections is partly a bit shorten compared to the upstream GMT documentation. Should I open a new PR to improve the PyGMT documentation for the UTM projection regading these three points, or do you prefer that this is also handled in this PR?

@willschlitzer willschlitzer added the skip-changelog Skip adding Pull Request to changelog label Aug 3, 2022
@willschlitzer
Copy link
Contributor

I'm looking at the upstream GMT documentation and this example. I think this example can be further improved in the following ways:

  1. The GMT documentation shows this figure, which I believe is very important to know the zone number in the projection setting. So I think we should also include this figure in this example:

  2. Two sentences in the GMT documentation are missing in this example:

    although a standard, you can change this with PROJ_SCALE_FACTOR
    For larger regions we use the conformal latitude in the general spherical formulae instead.

  3. This makes the UTM projection a secant projection and not a tangent projection like the transverse Mercator above.

    "the transverse Mercator above" doesn't make sense in this example. It should be linked to this link https://www.pygmt.org/dev/projections/cyl/cyl_transverse_mercator.html instead.

I agree with you on all three points. My impression is that the PyGMT documentation for the projections is partly a bit shorten compared to the upstream GMT documentation. Should I open a new PR to improve the PyGMT documentation for the UTM projection regading these three points, or do you prefer that this is also handled in this PR?

My vote it to leave this PR with the current changes and open up a separate one for the UTM documentation.

@seisman
Copy link
Member

seisman commented Aug 3, 2022

This means I finish the already opened PRs via my fork, and for all new PRs I create a branch directly in the PyGMT repro and open a PR from there, correct?

Yes.

I agree with you on all three points. My impression is that the PyGMT documentation for the projections is partly a bit shorten compared to the upstream GMT documentation. Should I open a new PR to improve the PyGMT documentation for the UTM projection regading these three points, or do you prefer that this is also handled in this PR?

My vote it to leave this PR with the current changes and open up a separate one for the UTM documentation.

I'm OK with a separate PR.

@seisman seisman merged commit 54b0a7f into GenericMappingTools:main Aug 3, 2022
@yvonnefroehlich yvonnefroehlich deleted the fix-typos-in-cyl-proj-exmp branch August 3, 2022 16:22
sixy6e pushed a commit to sixy6e/pygmt that referenced this pull request Dec 21, 2022
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation skip-changelog Skip adding Pull Request to changelog
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants