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

Make docstring style consistent with Python PEPs #1223

Merged
merged 1 commit into from
Jan 24, 2019
Merged

Make docstring style consistent with Python PEPs #1223

merged 1 commit into from
Jan 24, 2019

Conversation

davesque
Copy link
Contributor

What was wrong?

The style of some docstrings is not consistent with recommendations in PEP 257 and PEP 287.

How was it fixed?

Fixed them.

Cute Animal Picture

Put a link to a cute animal picture inside the parenthesis-->

kclowes
kclowes approved these changes Jan 24, 2019
View reviewed changes
Copy link
Collaborator

@kclowes kclowes left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM, thank you! Is there a way to enforce this via flake8?

@pipermerriam
Copy link
Member

@kclowes looks like we can do that with https://github.com/PyCQA/pydocstyle

@davesque davesque merged commit 0cf201a into ethereum:master Jan 24, 2019
@davesque davesque deleted the docstring-style branch January 24, 2019 22:19
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@kclowes kclowes kclowes approved these changes

Assignees
No one assigned
Labels
None yet
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
3 participants
@davesque @pipermerriam @kclowes