Skip to content

Fix Transverse Mercator documentation typo#2253

Closed
willschlitzer wants to merge 3 commits intomainfrom
projection-documentation-typo-fixes
Closed

Fix Transverse Mercator documentation typo#2253
willschlitzer wants to merge 3 commits intomainfrom
projection-documentation-typo-fixes

Conversation

@willschlitzer
Copy link
Contributor

@willschlitzer willschlitzer commented Dec 17, 2022 •
edited
Loading

Fixes the Transverse Mercator syntax issues in #2059.

Addresses #2059

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.
  • Use underscores (not hyphens) in names of Python files and directories.

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

@willschlitzer willschlitzer added documentation Improvements or additions to documentation skip-changelog Skip adding Pull Request to changelog labels Dec 17, 2022
@willschlitzer willschlitzer added this to the 0.8.0 milestone Dec 17, 2022
@willschlitzer willschlitzer self-assigned this Dec 17, 2022
yvonnefroehlich
yvonnefroehlich reviewed Dec 17, 2022
View reviewed changes
@yvonnefroehlich yvonnefroehlich mentioned this pull request Dec 20, 2022
Closed
65 tasks
willschlitzer and others added 2 commits December 20, 2022 10:28
@willschlitzer @yvonnefroehlich
Update examples/projections/table/README.txt
b04b622 
Co-authored-by: Yvonne Fröhlich <94163266+yvonnefroehlich@users.noreply.github.com>
@willschlitzer
Merge branch 'main' into projection-documentation-typo-fixes
1e9b6e1
@willschlitzer willschlitzer changed the title Fix projection documentation typos Fix Transverse mercator documentation typos Dec 20, 2022
@willschlitzer willschlitzer changed the title Fix Transverse mercator documentation typos Fix Transverse Mercator documentation typos Dec 20, 2022
@willschlitzer willschlitzer changed the title Fix Transverse Mercator documentation typos Fix Transverse Mercator documentation typo Dec 20, 2022
@seisman seisman added the final review call This PR requires final review and approval from a second reviewer label Dec 21, 2022
@yvonnefroehlich
Copy link
Member

yvonnefroehlich commented Dec 21, 2022

Hm. Do we plan to have separate PRs for each projection? The PR title was renamed to address only the "Transverse Mercator projection". However, there are some more typos to fix, at least the ones listed at #2059 (comment) 🙂.

@willschlitzer
Copy link
Contributor Author

willschlitzer commented Dec 21, 2022

Hm. Do we plan to have separate PRs for each projection? The PR title was renamed to address only the "Transverse Mercator projection". However, there are some more typos to fix, at least the ones listed at #2059 (comment) slightly_smiling_face.

@yvonnefroehlich I had originally planned to fix all of the typos, but I misinterpreted your original comment as asking for someone to fix them. Since I think there needs to be a bit more explanation on what PyGMT typos need fixing (discussed here) vs. what are issues with GMT documentation, it might just be easier if you submitted a PR with your desired fixes. Happy to help, but I don't want to duplicate effort.

@yvonnefroehlich
Copy link
Member

yvonnefroehlich commented Dec 21, 2022

Hm. Do we plan to have separate PRs for each projection? The PR title was renamed to address only the "Transverse Mercator projection". However, there are some more typos to fix, at least the ones listed at #2059 (comment) slightly_smiling_face.

@yvonnefroehlich I had originally planned to fix all of the typos, but I misinterpreted your original comment as asking for someone to fix them. Since I think there needs to be a bit more explanation on what PyGMT typos need fixing (discussed here) vs. what are issues with GMT documentation, it might just be easier if you submitted a PR with your desired fixes. Happy to help, but I don't want to duplicate effort.

No worries @willschlitzer! Firstly, I wanted only to know how to proceed with good first issue issues regarding the release 😉. But it was totally fine that you directly started working on this 🙂.

@GenericMappingTools/pygmt-maintainers and @willschlitzer Should we leave this PR as is and merge it and open a follow up PR for the remaining typo fixes, or do you prefer closing this PR without merging it and opening a new PR including this one typo fix, to have all these typo fixes together in one PR?
I can try working on this on the weekend, but I can not grant for this yet. Maybe we can bump the upstream GMT PR back to after the PyGMT v0.8.0 release?

@seisman
Copy link
Member

seisman commented Dec 22, 2022

Should we leave this PR as is and merge it and open a follow up PR for the remaining typo fixes, or do you prefer closing this PR without merging it and opening a new PR including this one typo fix, to have all these typo fixes together in one PR?

Either works. Or you can push more commits directly to this PR.

@seisman seisman removed the final review call This PR requires final review and approval from a second reviewer label Dec 22, 2022
@yvonnefroehlich yvonnefroehlich mentioned this pull request Dec 23, 2022
Merged
7 tasks
@yvonnefroehlich
Copy link
Member

yvonnefroehlich commented Dec 23, 2022

Should we leave this PR as is and merge it and open a follow up PR for the remaining typo fixes, or do you prefer closing this PR without merging it and opening a new PR including this one typo fix, to have all these typo fixes together in one PR?

Either works. Or you can push more commits directly to this PR.

I prefere working in an own PR on this and starte doing so in PR #2269.

@seisman
Copy link
Member

seisman commented Dec 24, 2022

Should we leave this PR as is and merge it and open a follow up PR for the remaining typo fixes, or do you prefer closing this PR without merging it and opening a new PR including this one typo fix, to have all these typo fixes together in one PR?

Either works. Or you can push more commits directly to this PR.

I prefere working in an own PR on this and starte doing so in PR #2269.

OK. I think we can close this PR.

@seisman seisman closed this Dec 24, 2022
@seisman seisman deleted the projection-documentation-typo-fixes branch December 24, 2022 05:17
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

@yvonnefroehlich yvonnefroehlich yvonnefroehlich left review comments

@seisman seisman seisman approved these changes

@michaelgrund michaelgrund michaelgrund approved these changes

Assignees

@willschlitzer willschlitzer

Labels

documentation Improvements or additions to documentation skip-changelog Skip adding Pull Request to changelog

Projects

None yet

Milestone

0.8.0

Development

Successfully merging this pull request may close these issues.

4 participants

@willschlitzer @yvonnefroehlich @seisman @michaelgrund