Skip to content

Add returns section to grdclip docstring #1388

@maxrjones

Description

@maxrjones

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:

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:
{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.

Metadata

Metadata

Assignees

No one assigned

    Labels

    documentationImprovements or additions to documentationgood first issueGood for newcomershelp wantedHelping hands are appreciated

    Type

    No type

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions