gh-150132: Document the no-argument overload of ConfigParser.items()#150133
Open
Taeknology wants to merge 1 commit into
Open
gh-150132: Document the no-argument overload of ConfigParser.items()#150133Taeknology wants to merge 1 commit into
Taeknology wants to merge 1 commit into
Conversation
…ems() The docstring of ConfigParser.items() only described the call with a section argument (returning a list of (name, value) tuples). The no-argument call delegates to MutableMapping.items() and returns an ItemsView of (section_name, section_proxy) pairs, which was previously undocumented. Reword the docstring so that both overloads are described and their return types match the actual behaviour.
|
Most changes to Python require a NEWS entry. Add one using the blurb_it web app or the blurb command-line tool. If this change has little impact on Python users, wait for a maintainer to apply the |
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
1 participant
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.
The docstring of
configparser.ConfigParser.items()only describedthe call with a section argument (returning a list of
(name, value)tuples). The no-argument call delegates to
collections.abc.MutableMapping.items()and returns anItemsViewof(section_name, section_proxy)pairs, which was previouslyundocumented.
This PR rewords the docstring so that both overloads are described and
their return types match the actual behaviour, matching what was done
for
Doc/library/configparser.rstin gh-149050 / gh-150059.Verified locally
Loaded the modified
Lib/configparser.pywithimportlib.util:and confirmed
help(ConfigParser.items)now describes both overloads.No code change. No
Misc/NEWS.dentry (docstring-only).Fixes #150132