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.

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

Write better docstrings #8

Open
kokkonisd opened this issue Jan 16, 2021 · 0 comments
Open

Write better docstrings #8

kokkonisd opened this issue Jan 16, 2021 · 0 comments
Assignees
@kokkonisd

Comments

@kokkonisd
Copy link
Contributor

Docstrings should all be formatted like this:

"""Imperative mood on the first line, for example "Describe" and not "Describes"

:param first_argument: the first argument is blablabla
:type first_argument: str
:param second_argument: the second argument is blablabla
:type second_argument: int
:return: something
:raise: Exception in the case of blablabla
"""
@kokkonisd kokkonisd self-assigned this Jan 16, 2021
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees

@kokkonisd kokkonisd

Labels
None yet
Projects
None yet
Milestone
No milestone
Development

No branches or pull requests
1 participant
@kokkonisd