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: Update docs to use consistently x * and y * #3862

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

Conversation

michaelgrund
Copy link
Member

@michaelgrund michaelgrund commented Mar 19, 2025

Description of proposed changes

Currently in the docs the versions

  • x direction
  • y direction
  • x-direction
  • y-direction
  • x-dimension
  • y-dimension
  • x axis
  • y axis
  • x-axis
  • y-axis

are used. The versions without '-' are used most frequently. This PR makes the docs consistent.

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.

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

Currently in the docs the versions 
- x direction
- y direction 
- x-direction
- y-direction
are used. The first two are used most frequently. This PR makes the docs consistent.
@michaelgrund michaelgrund added the documentation Improvements or additions to documentation label Mar 19, 2025
@michaelgrund michaelgrund added this to the 0.15.0 milestone Mar 19, 2025
@michaelgrund michaelgrund changed the title DOC: Update docs to use consistently x direction and y direction DOC: Update docs to use consistently x * and y * Mar 19, 2025
@michaelgrund michaelgrund added the needs review This PR has higher priority and needs review. label Mar 19, 2025
@yvonnefroehlich
Copy link
Member

Yeah, this is currently a bit inconsistent in the docs and examples.🙃. Actually, I believe we also use the upper case versions partly, e.g., https://www.pygmt.org/dev/api/generated/pygmt.Figure.text.html.

@seisman
Copy link
Member

seisman commented Mar 19, 2025

@michaelgrund
Copy link
Member Author

michaelgrund commented Mar 20, 2025

Perhaps "x-axis" is more common?

Means we should always use the hyphen version, so x-axis, x-direction, x-dimension etc. or differentiate between the individual terms?

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 needs review This PR has higher priority and needs review.
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants