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

Use numpydoc docstrings? #12

@choldgraf

Description

@choldgraf

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?

Metadata

Metadata

Assignees

No one assigned

    Labels

    No labels
    No labels

    Type

    No type

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions