-
Notifications
You must be signed in to change notification settings - Fork 233
Closed
Labels
documentationImprovements or additions to documentationImprovements or additions to documentation
Milestone
Description
I'll take the spacing parameter as an example, which is used in the xyz2grd and many other functions.
Here is the source code of the spacing docstrings:
pygmt/pygmt/helpers/decorators.py
Lines 300 to 302 in 5b4d5c3
| "spacing": r""" | |
| spacing : int or float or str or list or tuple | |
| *x_inc*\ [**+e**\|\ **n**][/\ *y_inc*\ [**+e**\|\ **n**]]. |
As you can see, currently, spacing is documented to support 5 types: int, float, str, list and tuple.
My thoughts:
- Simplify
int or floattofloat. If an argument can accept float (e.g., 1.0), it definitely can accept int (e.g., 1). It's not necessary to list both. - Simplify
list or tupletolistortupleor something else.
Metadata
Metadata
Assignees
Labels
documentationImprovements or additions to documentationImprovements or additions to documentation
