Skip to content

Commit 7ea183a

Browse files
yvonnefroehlichseismanmichaelgrund
authored
DOC: Update naming convention in contributors guide: separate words in parameter names by underscores (#4284)
Co-authored-by: Dongdong Tian <seisman.info@gmail.com> Co-authored-by: Michael Grund <23025878+michaelgrund@users.noreply.github.com>
1 parent b4a94d7 commit 7ea183a

File tree

1 file changed

+4
-4
lines changed

1 file changed

+4
-4
lines changed

doc/contributing.md

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -488,10 +488,10 @@ integration systems will warn us and you can make a new commit with the formatte
488488
Even better, you can just write `/format` in the first line of any comment in a
489489
pull request to lint the code automatically.
490490

491-
When wrapping a new alias, use an underscore to separate words bridged by vowels
492-
(aeiou), such as `no_skip` and `z_only`. Do not use an underscore to separate
493-
words bridged only by consonants, such as `distcalc`, and `crossprofile`. This
494-
convention is not applied by the code checking tools, but the PyGMT maintainers
491+
When introducing a new parameter name, use an underscore to separate words. This improves
492+
readability and aligns with the [PEP 8 style guide](https://peps.python.org/pep-0008/).
493+
For common shortcuts no underscore is needed, e.g., `surftype`, `outgrid`, or `timefmt`.
494+
This convention is not applied by the code checking tools, but the PyGMT maintainers
495495
will comment on any pull requests as needed.
496496

497497
When working on a tutorial or a gallery plot, it is good practice to use code

0 commit comments

Comments
 (0)