glue

glue copied to clipboard

@ChrisBeaumont - When working on some other PRs, I was going to clean up a few docstrings to change the

        :param x: x pixel location in slice array
        :param y: y pixel location in slice array

syntax to the numpydoc syntax but I wanted to first check if that should be the goal in the long term, or whether you actually want everything to be in the syntax above? I have a preference for numpydoc for consistency with numpy/scipy/matplotlib/astropy but let me know what you think.

Assuming sphinx is set up to render both styles properly, transitioning to numpydoc is fine by me

As a reference:

• The numpydoc tool.
• Numpy documentation howto.
• Astropy docstring documentation.

(#509 Is a clone of this issue, so I guess I should continue discussion here.)

I'm tagging this as effort-low since anyone can work on it for just a few files.

Wow, this has been sitting around for a while! For a heads up. both Numpy and Astropy docs now refer to https://numpydoc.readthedocs.io/en/latest/format.html#docstring-standard.