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

Fiddle with multi-line docstrings #24

Closed
Ichimonji10 opened this issue Oct 29, 2015 · 1 comment
Closed

Fiddle with multi-line docstrings #24

Ichimonji10 opened this issue Oct 29, 2015 · 1 comment

Comments

@Ichimonji10
Copy link
Contributor

From #20 (comment):

the recommended way for multiline docstring is like example below ( see https://www.python.org/dev/peps/pep-0008/#documentation-strings for more information):

"""Return a foobang

Optional plotz says to frobnicate the bizbaz first.
"""

In other words, the closing """ should stay on its own line and don't need a blank line before it.

This makes sense. Let's implement this new format throughout the application. Making this change has value because it'll make the code base more palatable to other developers who are familiar with PEP8 (and PEP257).

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

2 participants