Skip to content
This repository has been archived by the owner on Jan 1, 2020. It is now read-only.

Use numpydoc docstrings? #12

Open
choldgraf opened this issue Jan 21, 2017 · 0 comments
Open

Use numpydoc docstrings? #12

choldgraf opened this issue Jan 21, 2017 · 0 comments

Comments

@choldgraf
Copy link

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?

Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Labels
None yet
Projects
None yet
Development

No branches or pull requests

1 participant