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: Make usage of "lowercase" and "uppercase" consistent across all docs #3756

Merged
merged 20 commits into from
Jan 9, 2025

Conversation

michaelgrund
Copy link
Member

Description of proposed changes

In the docs we use lowercase/uppercase, lower-case/upper-case and lower case/upper case. This PR makes all appearances consistent to use lowercase/uppercase.

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

  • /format: automatically format and lint the code

@michaelgrund michaelgrund added the documentation Improvements or additions to documentation label Jan 8, 2025
@michaelgrund michaelgrund added this to the 0.15.0 milestone Jan 8, 2025
@michaelgrund michaelgrund added needs review This PR has higher priority and needs review. skip-changelog Skip adding Pull Request to changelog labels Jan 8, 2025
@seisman
Copy link
Member

seisman commented Jan 8, 2025

I have no strong opinion on which one is correct or better. So assign this PR to @yvonnefroehlich.

If the PR looks good, please don't forget to also update the following lines:

$ ack '[Ll]ower[ -]case'
pygmt/src/project.py
139:        Use lower case. The output will be columns of values corresponding to

$ ack '[Uu]pper[ -]case'
pygmt/helpers/decorators.py
122:                  change in the x coordinates (upper case to use projected
125:                  change in the y coordinates (upper case to use projected
128:                  distance between coordinates (upper case to use projected

Copy link
Member

@yvonnefroehlich yvonnefroehlich left a comment

Choose a reason for hiding this comment

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

I personally do not really like the hyphen version and the internet says with white space is British and without American, so I agree with @michaelgrund to use the version without white space. Happy that this is now consistent.

@seisman seisman removed the needs review This PR has higher priority and needs review. label Jan 9, 2025
@seisman seisman merged commit d33e5ac into main Jan 9, 2025
21 checks passed
@seisman seisman deleted the docs-lowercase branch January 9, 2025 00:54
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