api-python icon indicating copy to clipboard operation
api-python copied to clipboard

Use numpydoc docstrings?

Open choldgraf opened this issue 8 years ago • 0 comments
trafficstars

It would be more clear how this package fits into the python science ecosystem if the docstrings followed the numpydoc format (here is its explanation). This basically entails writing parameters etc with the following form:

def my_function(a, b=None):
    """Do my function.
        
        This function does blah blah.

        Parameters
        -----------
        a : int | float
            Explanation of a.
        b : string | None
            Explanation of b.

        Returns
        --------
        something : instance of XXX
            Explanation of something
    """
and so on...

I think this would make the documentation more readable, and it'd make it possible to build API docs on the web quite easily. What are thoughts on using this?

choldgraf avatar Jan 21 '17 17:01 choldgraf