FazBrowse GitHub Viewer | Trending |
URL:
| Home
Tools: [Download Repo ZIP]   [Original HTTPS Page]

gh-141510: Update PyDict C API doc for frozendict by vstinner · Pull Request #145533 · python/cpython · GitHub

/ cpython Public

gh-141510: Update PyDict C API doc for frozendict - #145533

Merged
vstinner merged 6 commits into
python:mainfrom
vstinner:frozendict_capi_doc
Mar 12, 2026
ConversationCommits (6)ChecksFiles changed
Merged

gh-141510: Update PyDict C API doc for frozendict#145533
vstinner merged 6 commits into
python:mainfrom
vstinner:frozendict_capi_doc

Conversation

vstinner commented Mar 5, 2026 •
edited by github-actions Bot
Loading

Copy link
Copy Markdown
Member

Mention frozendict support.

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

vstinner requested a review from ZeroIntensity as a code owner March 5, 2026 12:09
bedevere-app Bot added the docs Documentation in the Doc dir label Mar 5, 2026
bedevere-app Bot mentioned this pull request Mar 5, 2026
Closed
github-project-automation Bot moved this to Todo in Docs PRs Mar 5, 2026

vstinner commented Mar 5, 2026

Copy link
Copy Markdown
Member Author

I used test_capi.test_dict to check if PyDict functions accept frozendict or not.

cc @encukou

encukou reviewed Mar 5, 2026
View reviewed changes

encukou left a comment

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Choose a reason Spam Abuse Off Topic Outdated Duplicate Resolved Low Quality

You've missed PyDict_Contains.

I think the info for the current behaviour should be in the main text, not in the versionchanged directive. If nothing else, there's been a suggestion to hide these for older versions.

Comment thread Doc/c-api/dict.rst Outdated

vstinner commented Mar 5, 2026

Copy link
Copy Markdown
Member Author

You've missed PyDict_Contains.

Oops, fixed.

I think the info for the current behaviour should be in the main text, not in the versionchanged directive.

I updated the PR to mention frozendict in the main text. I kept versionchanged. I'm not sure if you want both, or only changing the main text.

vstinner commented Mar 9, 2026

Copy link
Copy Markdown
Member Author

@encukou and/or @ZeroIntensity: Do you want to review this change?

ZeroIntensity reviewed Mar 9, 2026
View reviewed changes
Comment thread Doc/c-api/dict.rst Outdated
Comment thread Doc/c-api/dict.rst Outdated
encukou reviewed Mar 10, 2026
View reviewed changes
Comment thread Doc/c-api/dict.rst
Comment on lines +48 to +50
.. versionchanged:: next
Also accept :class:`frozendict`.

encukou Mar 10, 2026

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Choose a reason Spam Abuse Off Topic Outdated Duplicate Resolved Low Quality

Now, do we need versionchanged at all, since frozendict was added in this version?

Suggested change
.. versionchanged:: next
Also accept :class:`frozendict`.

ZeroIntensity Mar 10, 2026

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Choose a reason Spam Abuse Off Topic Outdated Duplicate Resolved Low Quality

I think it's nice to have an explicit historical record.

vstinner Mar 10, 2026

Copy link
Copy Markdown
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Choose a reason Spam Abuse Off Topic Outdated Duplicate Resolved Low Quality

I prefer to be explicit about the change.

ZeroIntensity approved these changes Mar 10, 2026
View reviewed changes

ZeroIntensity left a comment

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Choose a reason Spam Abuse Off Topic Outdated Duplicate Resolved Low Quality

LGTM

vstinner merged commit d4cc553 into python:main Mar 12, 2026
32 checks passed
vstinner deleted the frozendict_capi_doc branch March 12, 2026 14:04
github-project-automation Bot moved this from Todo to Done in Docs PRs Mar 12, 2026

vstinner commented Mar 12, 2026

Copy link
Copy Markdown
Member Author

PR merged, thanks for your reviews!

ljfp pushed a commit to ljfp/cpython that referenced this pull request Apr 25, 2026
pythongh-141510: Update PyDict C API doc for frozendict (python#145533)
00ed59c 
Mention frozendict support.
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
Show hidden characters
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

encukou encukou left review comments
ZeroIntensity ZeroIntensity approved these changes

Assignees

No one assigned

Labels

docs Documentation in the Doc dir skip news

Projects

Docs PRs
Status: Done

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

3 participants

Back | FazBrowse Home | New Git URL