Repository navigation
attrdoc: clean attribute docstrings - #192
Merged
Merged
Conversation
parse_from_object() took an attribute's docstring, written below it in the class body, as it stood in the source, with its indent and the blank lines around it. It is now cleaned as a docstring is.
This file contains hidden or 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
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.
Covers item 7 from the BEHAVIOR.md review for #136:
parse_from_object"cleans the descriptions of attribute docstrings the same way as other docstrings".An attribute docstring is the string written below an attribute in the class body.
parse_from_object()used to return it exactly as it appeared in the source, with its indent and the blank lines around it. It is now cleaned the way any docstring is: the common indent and the surrounding blank lines are removed, and relative indents are kept.Case diffs: none. Parity against origin/main: 0 of 29184 docstrings differ (case 0, stdlib 0, generated 0). The change only affects
parse_from_object().