-
Notifications
You must be signed in to change notification settings - Fork 228
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
base: main
Are you sure you want to change the base?
Conversation
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.
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. |
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? |
I have no strong preference regarding with or without a hyphen. It seems other projects use mainly a hyphen in their docs. However, I would not make a difference between the single terms, as I feel it makes things more complicated, and we may get confused by ourselves. |
I feel both versions (with or without hyphens) are used in literature. So, we just need to be consistent, and I'm inclined to the with-hyphen version, since x-axis/y-axis are used in matplotlib and matlab. |
Description of proposed changes
Currently in the docs the versions
are used. The versions without '-' are used most frequently. This PR makes the docs consistent.
Preview:
Reminders
make format
andmake check
to make sure the code follows the style guide.doc/api/index.rst
.Slash Commands
You can write slash commands (
/command
) in the first line of a comment to performspecific operations. Supported slash command is:
/format
: automatically format and lint the code