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

Use imperative mood in docstrings. #362

Merged
merged 3 commits into from
Dec 10, 2019

Conversation

nuclearsandwich
Copy link
Member

Where class names alone were not grammatical I elaborated with
superclass names to get a valid imperative sentence.

Fixes D401 in pydocstyle and flake8.

Contributes to closing ros2/build_farmer#255

Signed-off-by: Steven! Ragnarök steven@nuclearsandwich.com

Where class names alone were not grammatical I elaborated with
superclass names to get a valid imperative sentence.

Fixes D401 in pydocstyle and flake8.

Signed-off-by: Steven! Ragnarök <steven@nuclearsandwich.com>
@wuffle-ros wuffle-ros bot added the in review Waiting for review (Kanban column) label Dec 9, 2019
@nuclearsandwich
Copy link
Member Author

Signed-off-by: Steven! Ragnarök <steven@nuclearsandwich.com>
@nuclearsandwich nuclearsandwich force-pushed the nuclearsandwich/resolve-d401 branch from 038dbe9 to ca50916 Compare December 9, 2019 21:01
@nuclearsandwich nuclearsandwich changed the title Use imperative mood in constructor docstrings. Use imperative mood in docstrings. Dec 9, 2019
Copy link
Member

@wjwwood wjwwood left a comment

Choose a reason for hiding this comment

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

lgtm other than comment


This directory caches those eggs to prevent repeated downloads.

However, it is safe to delete this directory.
Copy link
Member

Choose a reason for hiding this comment

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

Is this file intentional?

Copy link
Member Author

Choose a reason for hiding this comment

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

No. I'll cut that out.

Signed-off-by: Steven! Ragnarök <steven@nuclearsandwich.com>
@nuclearsandwich nuclearsandwich force-pushed the nuclearsandwich/resolve-d401 branch from dead59b to 3603245 Compare December 10, 2019 03:30
@nuclearsandwich nuclearsandwich merged commit 7b6f4e0 into master Dec 10, 2019
@nuclearsandwich nuclearsandwich deleted the nuclearsandwich/resolve-d401 branch December 10, 2019 03:30
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
in review Waiting for review (Kanban column)
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants