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.

Sign up for GitHub

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

Jump to bottom

Polish the documentation #46

Open

3 tasks

SophieAltenburg opened this issue May 14, 2020 · 0 comments

Labels

Milestone

Contributor

SophieAltenburg commented May 14, 2020

It should be

complete
correct
in sphinx-numpy format, which is:

This function does bla.

Parameters
------------
boo (type):
    This parameter is used for bees.

Returns
--------
A magnificant value of type blub.

Raises
-------
BlobError:
    If there is a blob forming that swallows everything along the way.

The text was updated successfully, but these errors were encountered:

SophieAltenburg added the documentation label

SophieAltenburg added this to the dev-0.1b milestone

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment