gh-155236: Add the dedent parameter in inspect.cleandoc() and inspect.getdoc() - #155237
Open
serhiy-storchaka wants to merge 1 commit into
Open
gh-155236: Add the dedent parameter in inspect.cleandoc() and inspect.getdoc()#155237serhiy-storchaka wants to merge 1 commit into
serhiy-storchaka wants to merge 1 commit into
Conversation
…etdoc() pydoc no longer dedents documentation strings, so the indentation of the parameter descriptions generated by Argument Clinic is preserved and does not depend on the rest of the docstring. Co-Authored-By: Claude Opus 5 (1M context) <noreply@anthropic.com>
Documentation build overview
|
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.
pydocno longer dedents documentation strings, so the indentation of the parameter descriptions generated by Argument Clinic is preserved and does not depend on the rest of the docstring.Only documentation strings written in C are affected -- 96 objects, like
bin(),print()and thebytesmethods. Docstrings written in the source code are dedented by the compiler since 3.13, so their rendering does not change.Removing the dedenting from
cleandoc()itself is not an option: it is still needed for documentation strings extracted from the source code (ast.get_docstring(),pygettext) and for arbitrary indented text.