gh-137112: Improve str() docstring defaults and wording #142650
+17
−5
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.
Summary
Update the
str()docstring to make default argument values explicit and alignthe wording with the documented signature.
Rationale
The existing docstring did not surface the default values for
encodinganderrorsin the signature and used older wording referring to“bytes_or_buffer”. This made the help output less clear in IDEs and interactive
tools such as
help()andpydoc.This change follows the guidance discussed in the issue and aligns the docstring
with the current documentation style.
Changes
str()docstring signature to include default values forencodinganderrorspydocoutputTesting
Lib/test/test_pydoc/test_pydoc.pyRelated issue
str()should show the default values for object, encoding and errors and should saybytes-like object#137112