Remove module docstring titles #10212
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
AA-Turner
force-pushed
the
remove-module-docstring-titles
branch
from
2c06c32
to
f05d455
Compare
|
@tk0miya I've fixed all the ones you raised. A |
AA-Turner
force-pushed
the
remove-module-docstring-titles
branch
from
f59fc41
to
f05a068
Compare
|
Thank you for your update. Merging now. Good work! |
Sign up for free
to subscribe to this conversation on GitHub.
Already have an account?
Sign in.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Closes #10160
Alternative to #10208
@tk0miya -- I had been working on an expanded version of your PR, you beat me to it!
Over and above #10208, this conforms module docstrings to PEP 257 by moving the summary line next to the opening quotes, dedents the text, ensures summary lines are less than 80 characters, and also removes redundant copyright & licencing information (see this post for more infomation on why this is OK.)
I did keep the copyright notices where a different licence has been used, though.
A