-
Notifications
You must be signed in to change notification settings - Fork 244
Closed
Labels
documentationImprovements or additions to documentationImprovements or additions to documentationgood first issueGood for newcomersGood for newcomershelp wantedHelping hands are appreciatedHelping hands are appreciated
Description
The docstring in pygmt/src/grdclip.py needs a 'Returns' section.
To fix this issue, copy and paste L82-89 in pygmt/src/grdcut.py:
Lines 81 to 89 in 9efe317
| Returns | |
| ------- | |
| ret: xarray.DataArray or None | |
| Return type depends on whether the ``outgrid`` parameter is set: | |
| - :class:`xarray.DataArray` if ``outgrid`` is not set | |
| - None if ``outgrid`` is set (grid output will be stored in file set by | |
| ``outgrid``) |
to add a returns section between L70 and L71 in
pygmt/src/grdclip.py:Lines 70 to 71 in 9efe317
| {V} | |
| """ |
A local development environment is not needed to address this issue (no installation required) 🎉 Just follow these instructions for editing the documentation on GitHub: https://www.pygmt.org/dev/contributing.html#editing-the-documentation-on-github.
Reactions are currently unavailable
Metadata
Metadata
Assignees
Labels
documentationImprovements or additions to documentationImprovements or additions to documentationgood first issueGood for newcomersGood for newcomershelp wantedHelping hands are appreciatedHelping hands are appreciated