Skip to content

Commit

Permalink
MNT: Add notion on naming/order of arguments to Contributor's guide
Browse files Browse the repository at this point in the history
  • Loading branch information
dopplershift committed Jan 13, 2020
1 parent fcdf756 commit 0e9a1f9
Showing 1 changed file with 4 additions and 0 deletions.
4 changes: 4 additions & 0 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -51,6 +51,10 @@ Other items:
to break other users' code, so care must be taken not to introduce bugs.
* Be aware that the pull request review process is not immediate, and is
generally proportional to the size of the pull request.
* Function arguments:
- Use full names for parameters rather than symbols (e.g. temperature instead of t)
- Order: pressure/height -> temperature/wind -> moisture (in general, but not a hard and
fast rule--like to allow for some default arguments).

## Reporting a bug
The easiest way to get involved is to report issues you encounter when using MetPy or by
Expand Down

0 comments on commit 0e9a1f9

Please sign in to comment.