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

docstrings format #28

Open
reisub-de opened this issue Sep 20, 2017 · 1 comment
Open

docstrings format #28

reisub-de opened this issue Sep 20, 2017 · 1 comment

Comments

@reisub-de
Copy link
Contributor

reisub-de commented Sep 20, 2017 •
edited
Loading

Should we include a parameter and return value description in the docstring of important/complicated methods? I think it would be handy. If yes, which format?

I like this style

"""
Description

:param a:  blabla
:return: blabla
:raises Exception: blabla
"""

For a overview, see https://stackoverflow.com/a/24385103
@hgn
Copy link
Member

hgn commented Sep 21, 2017

Ack, looks readable and structured. Nice

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees
No one assigned
Labels
None yet
Projects
None yet
Milestone
No milestone
Development

No branches or pull requests
2 participants
@hgn @reisub-de