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 documentation and codes #3370

Merged
merged 16 commits into from
Sep 4, 2024
Merged

Fix typos in documentation and codes #3370

merged 16 commits into from
Sep 4, 2024

Conversation

yvonnefroehlich
Copy link
Member

@yvonnefroehlich yvonnefroehlich commented Aug 4, 2024

Description of proposed changes

Fix some typos.
Maybe we can leave this PR open and collect any other typos until releasing v0.13.0.

Preview:

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 command is:

  • /format: automatically format and lint the code

@yvonnefroehlich yvonnefroehlich added the documentation Improvements or additions to documentation label Aug 4, 2024
@yvonnefroehlich yvonnefroehlich added this to the 0.13.0 milestone Aug 4, 2024
@yvonnefroehlich yvonnefroehlich changed the title Fix typos WIP: Fix typos Aug 4, 2024
@yvonnefroehlich yvonnefroehlich added scipy-sprint Things to work on during the SciPy sprint! skip-changelog Skip adding Pull Request to changelog and removed scipy-sprint Things to work on during the SciPy sprint! labels Aug 4, 2024
@seisman seisman marked this pull request as draft August 4, 2024 17:00
@seisman
Copy link
Member

seisman commented Aug 4, 2024

Fix some typos.
Maybe we can leave this PR open and collect any other typos until releasing v0.13.0.

Sounds good, and mark the PR as Draft to save CI resources.

@yvonnefroehlich yvonnefroehlich mentioned this pull request Aug 7, 2024
39 tasks
Co-authored-by: Dongdong Tian <[email protected]>
@seisman
Copy link
Member

seisman commented Aug 7, 2024

Change "GMT" to "PyGMT"?

GMT supports a number of encodings and each encoding contains a set of ASCII and

Change

<https://en.wikipedia.org/wiki/ISO/IEC_8859>

to

[ISO/IEC_8859](https://en.wikipedia.org/wiki/ISO/IEC_8859)

<https://en.wikipedia.org/wiki/ISO/IEC_8859> for descriptions of the different parts of

and also make similar changes to following lines?

- <https://en.wikipedia.org/wiki/ISO/IEC_8859-1>
- <https://en.wikipedia.org/wiki/ISO/IEC_8859-2>
- <https://en.wikipedia.org/wiki/ISO/IEC_8859-3>
- <https://en.wikipedia.org/wiki/ISO/IEC_8859-4>
- <https://en.wikipedia.org/wiki/ISO/IEC_8859-5>
- <https://en.wikipedia.org/wiki/ISO/IEC_8859-6>
- <https://en.wikipedia.org/wiki/ISO/IEC_8859-7>
- <https://en.wikipedia.org/wiki/ISO/IEC_8859-8>
- <https://en.wikipedia.org/wiki/ISO/IEC_8859-9>
- <https://en.wikipedia.org/wiki/ISO/IEC_8859-10>
- <https://en.wikipedia.org/wiki/ISO/IEC_8859-11>
- <https://en.wikipedia.org/wiki/ISO/IEC_8859-13>
- <https://en.wikipedia.org/wiki/ISO/IEC_8859-14>
- <https://en.wikipedia.org/wiki/ISO/IEC_8859-15>
- <https://en.wikipedia.org/wiki/ISO/IEC_8859-16>

@yvonnefroehlich
Copy link
Member Author

yvonnefroehlich commented Aug 7, 2024

Change "GMT" to "PyGMT"?

GMT supports a number of encodings and each encoding contains a set of ASCII and

Done in commit 3483545.

Change

<https://en.wikipedia.org/wiki/ISO/IEC_8859>

to

[ISO/IEC_8859](https://en.wikipedia.org/wiki/ISO/IEC_8859)

All links are re-written in this form in commit 96fdc6d.

@seisman seisman changed the title WIP: Fix typos Fix typos in documentation and codes Sep 3, 2024
@seisman seisman marked this pull request as ready for review September 3, 2024 15:20
@seisman seisman added final review call This PR requires final review and approval from a second reviewer and removed final review call This PR requires final review and approval from a second reviewer labels Sep 3, 2024
@seisman seisman merged commit 6dc8eb0 into main Sep 4, 2024
9 of 12 checks passed
@seisman seisman deleted the fix-typos-72 branch September 4, 2024 05:49
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