Skip to content

Conversation

Prometheus3375
Copy link
Contributor

@Prometheus3375 Prometheus3375 commented Oct 14, 2024

Changes made:

  1. Removed premature period introduced in gh-116938: Clarify documentation of dict and dict.update regarding the positional argument they accept #125213.
  2. Added a similar update made for MutableMapping.update to dict.update docstring. Also changed dict/iterable to mapping/iterable as E can be indeed any mapping object, not just dict.

📚 Documentation preview 📚: https://cpython-previews--125421.org.readthedocs.build/

@methane methane added docs Documentation in the Doc dir needs backport to 3.12 only security fixes needs backport to 3.13 bugs and security fixes labels Oct 14, 2024
@Viicos
Copy link
Contributor

Viicos commented Oct 14, 2024

Thanks @Prometheus3375 for catching these issues

@methane
Copy link
Member

methane commented Oct 14, 2024

LGTM, but I don't merge this yet to ensure a chance for other core developers to review.
Ping me two week later if no other reviews.

@Prometheus3375
Copy link
Contributor Author

@methane 2 weeks have passed, nobody else reviewed.

@AA-Turner AA-Turner enabled auto-merge (squash) October 29, 2024 22:31
@AA-Turner AA-Turner changed the title gh-116938: Fix dict.update docstring and remove redundant period from dict web documentation gh-116938: Fix dict.update docstring and remove erraneous full stop from dict documentation Oct 29, 2024
@AA-Turner AA-Turner merged commit 5527c40 into python:main Oct 29, 2024
39 checks passed
@miss-islington-app
Copy link

Thanks @Prometheus3375 for the PR, and @AA-Turner for merging it 🌮🎉.. I'm working now to backport this PR to: 3.12, 3.13.
🐍🍒⛏🤖

miss-islington pushed a commit to miss-islington/cpython that referenced this pull request Oct 29, 2024
…l stop from `dict` documentation (pythonGH-125421)

(cherry picked from commit 5527c40)

Co-authored-by: Prometheus3375 <[email protected]>
Co-authored-by: Adam Turner <[email protected]>
miss-islington pushed a commit to miss-islington/cpython that referenced this pull request Oct 29, 2024
…l stop from `dict` documentation (pythonGH-125421)

(cherry picked from commit 5527c40)

Co-authored-by: Prometheus3375 <[email protected]>
Co-authored-by: Adam Turner <[email protected]>
@bedevere-app
Copy link

bedevere-app bot commented Oct 29, 2024

GH-126150 is a backport of this pull request to the 3.13 branch.

@bedevere-app bedevere-app bot removed the needs backport to 3.13 bugs and security fixes label Oct 29, 2024
@bedevere-app
Copy link

bedevere-app bot commented Oct 29, 2024

GH-126151 is a backport of this pull request to the 3.12 branch.

@bedevere-app bedevere-app bot removed the needs backport to 3.12 only security fixes label Oct 29, 2024
AA-Turner added a commit that referenced this pull request Oct 29, 2024
…ll stop from `dict` documentation (GH-125421) (#126151)

gh-116938: Fix `dict.update` docstring and remove erraneous full stop from `dict` documentation (GH-125421)
(cherry picked from commit 5527c40)

Co-authored-by: Prometheus3375 <[email protected]>
Co-authored-by: Adam Turner <[email protected]>
AA-Turner added a commit that referenced this pull request Oct 29, 2024
…ll stop from `dict` documentation (GH-125421) (#126150)

gh-116938: Fix `dict.update` docstring and remove erraneous full stop from `dict` documentation (GH-125421)
(cherry picked from commit 5527c40)

Co-authored-by: Prometheus3375 <[email protected]>
Co-authored-by: Adam Turner <[email protected]>
@Prometheus3375 Prometheus3375 deleted the gh-116938-fix-typos branch November 2, 2024 17:16
picnixz pushed a commit to picnixz/cpython that referenced this pull request Dec 8, 2024
…l stop from `dict` documentation (python#125421)

Co-authored-by: Adam Turner <[email protected]>
ebonnal pushed a commit to ebonnal/cpython that referenced this pull request Jan 12, 2025
…l stop from `dict` documentation (python#125421)

Co-authored-by: Adam Turner <[email protected]>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

docs Documentation in the Doc dir skip news

Projects

None yet

Development

Successfully merging this pull request may close these issues.

6 participants