Thanks to visit codestin.com
Credit goes to github.com

Skip to content

Imperative mood for docstring summaries #92

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

Merged
merged 16 commits into from
Jan 7, 2020
Merged

Imperative mood for docstring summaries #92

merged 16 commits into from
Jan 7, 2020

Conversation

lukelbd
Copy link
Collaborator

@lukelbd lukelbd commented Dec 19, 2019

This PR will switch all one-sentence docstring summaries to the imperative mood. This is the convention used by almost all other python projects.

These changes have already been made in #50 (in the future will break things up into smaller PRs), will just copy them over.

@lukelbd
Copy link
Collaborator Author

lukelbd commented Jan 7, 2020

I also added a Proj change from #50. Proj now behaves just like all other constructor functions, returning just the class instance (rather than (map, aspect)) and optionally accepting instances.

This PR constitutes the last of the changes from #50 that can be merged into master! The remaining PRs are much smaller and more self-contained, and #50 is limited strictly to the topic in the title.

@lukelbd lukelbd merged commit 71e821e into master Jan 7, 2020
@lukelbd lukelbd deleted the imperative-mood branch January 7, 2020 12:57
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

1 participant