docs: correct outdated MappingProxyType docstrings #30281
Merged
Conversation
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
The docstrings for MappingProxyType's keys(), values(), and items() methods were never updated to reflect the changes that Python 3 brought to these APIs, namely returning views rather than lists.
AlexWaygood
added
needs backport to 3.9
JelleZijlstra
approved these changes
Jan 19, 2022
gvanrossum
approved these changes
Jan 19, 2022
|
Thanks @jab for the PR, and @gvanrossum for merging it 🌮🎉.. I'm working now to backport this PR to: 3.9, 3.10. |
|
@gvanrossum: Please replace |
|
GH-30709 is a backport of this pull request to the 3.10 branch. |
|
GH-30710 is a backport of this pull request to the 3.9 branch. |
miss-islington
pushed a commit
to miss-islington/cpython
that referenced
this pull request
Jan 19, 2022
The docstrings for MappingProxyType's keys(), values(), and items() methods were never updated to reflect the changes that Python 3 brought to these APIs, namely returning views rather than lists. (cherry picked from commit 2d10fa9) Co-authored-by: Joshua Bronson <jabronson@gmail.com>
miss-islington
pushed a commit
to miss-islington/cpython
that referenced
this pull request
Jan 19, 2022
The docstrings for MappingProxyType's keys(), values(), and items() methods were never updated to reflect the changes that Python 3 brought to these APIs, namely returning views rather than lists. (cherry picked from commit 2d10fa9) Co-authored-by: Joshua Bronson <jabronson@gmail.com>
miss-islington
added a commit
that referenced
this pull request
Jan 19, 2022
The docstrings for MappingProxyType's keys(), values(), and items() methods were never updated to reflect the changes that Python 3 brought to these APIs, namely returning views rather than lists. (cherry picked from commit 2d10fa9) Co-authored-by: Joshua Bronson <jabronson@gmail.com>
miss-islington
added a commit
that referenced
this pull request
Jan 19, 2022
The docstrings for MappingProxyType's keys(), values(), and items() methods were never updated to reflect the changes that Python 3 brought to these APIs, namely returning views rather than lists. (cherry picked from commit 2d10fa9) Co-authored-by: Joshua Bronson <jabronson@gmail.com>
hello-adam
pushed a commit
to hello-adam/cpython
that referenced
this pull request
Jun 2, 2022
The docstrings for MappingProxyType's keys(), values(), and items() methods were never updated to reflect the changes that Python 3 brought to these APIs, namely returning views rather than lists. (cherry picked from commit 2d10fa9) Co-authored-by: Joshua Bronson <jabronson@gmail.com>
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.
The docstrings for
MappingProxyType'skeys(),values(), anditems()methods were never updated to reflect the changes that Python 3 brought to these APIs, namely returning views rather than lists.It looks like these docstrings were originally copy-pasted from
dict's in the Python 2 days, but were never updated to matchdict's updated docstrings when these APIs changed.Ideally these would be DRY'd to prevent future drift, but will leave that for another day.
Looks like creating a BPO issue for this would not be normative for such a trivial PR, so I've skipped doing that.
Hope this helps!