Fix for PEP 257 #1136
Open
Fix for PEP 257 #1136
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
charlie-rivos
force-pushed
the
dev/charlie/remove_newline
branch
2 times, most recently
from
8e15522 to
c0b48a4
Compare
Docstrings are defined in PEP 257 as "A docstring is a string literal that occurs as the first statement in a module, function, class, or method definition." When reuse adds a header, it forcibly adds a space before the docstring violating this principle. When the style is set to Python and the first line in the file is a docstring, do not add a space between the license and the docstring. Signed-off-by: Charlie Jenkins <[email protected]>
charlie-rivos
force-pushed
the
dev/charlie/remove_newline
branch
from
c0b48a4 to
98401a1
Compare
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
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.
Docstrings are defined in PEP 257 as "A docstring is a string literal that occurs as the first statement in a module, function, class, or method definition." When reuse adds a header, it forcibly adds a space before the docstring violating this principle.
When the style is set to Python and the first line in the file is a docstring, do not add a space between the license and the docstring.
More information can be seen here: https://peps.python.org/pep-0257/
closes #1138
changelog.d/<directory>/.AUTHORS.rst.docs/man/or elsewhere.the current specification.
changed files.