Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Ensure good documentation for functions #6

Open
mandel01 opened this issue Feb 1, 2017 · 1 comment
Open

Ensure good documentation for functions #6

mandel01 opened this issue Feb 1, 2017 · 1 comment

Comments

@mandel01
Copy link
Contributor

mandel01 commented Feb 1, 2017

Here is a reference for numpy-stype docstrings

@mandel01 mandel01 mentioned this issue Feb 1, 2017
@mandel01
Copy link
Contributor Author

mandel01 commented Feb 2, 2017

Here's the numpy docstring convention I forgot to include. I am still learning more about them but the simple example below provides a nice standard structure.

def func(arg1, arg2):
    """Summary line.

    Extended description of function.

    Parameters
    ----------
    arg1 : int
        Description of arg1
    arg2 : str
        Description of arg2

    Returns
    -------
    bool
        Description of return value

    """
    return True

And here's a more complicated reference...
https://github.com/numpy/numpy/blob/master/doc/HOWTO_DOCUMENT.rst.txt

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

No branches or pull requests

1 participant