Skip to content

gh-141004: Document PyODict* APIs - #141136

Merged
ZeroIntensity merged 7 commits into
python:mainfrom
ZeroIntensity:document-pyodict
Nov 17, 2025
Merged

gh-141004: Document PyODict* APIs#141136
ZeroIntensity merged 7 commits into
python:mainfrom
ZeroIntensity:document-pyodict

Conversation

@ZeroIntensity

@ZeroIntensityZeroIntensity commented Nov 6, 2025

Copy link
Copy Markdown
Member

Comment threadDoc/c-api/dict.rst Outdated
Comment on lines +461 to +462
Return true if *od* is a dict object, but not an instance of a subtype of
the :class:`~collections.OrderedDict` type. This function always succeeds.

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.

Suggested change
Return true if *od* is a dict object, but not an instance of a subtype of
the :class:`~collections.OrderedDict` type. This function always succeeds.
Return true if *od* is an ordered dictionary object, but not
an instance of a subtype of the :class:`~collections.OrderedDict` type.
This function always succeeds.
- a dict object+ an ordered dictionary object

Copy link
Copy Markdown
MemberAuthor

Choose a reason for hiding this comment

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

Applied this one locally because I didn't want to deal with conflicts.

Comment threadDoc/c-api/dict.rst Outdated
Comment on lines +448 to +449
Since Python 3.7, dictionaries are ordered by default, so there is usually
little need for this object.

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.

I suggest moving this to the introductory paragraph.

Copy link
Copy Markdown
MemberAuthor

Choose a reason for hiding this comment

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

Done.

Comment threadDoc/c-api/dict.rst
@ZeroIntensity

Copy link
Copy Markdown
MemberAuthor

I'd like to finish #141009 before doing this one.

@StanFromIrelandStanFromIreland 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.

LGTM

@ZeroIntensityZeroIntensity added needs backport to 3.13 bugs and security fixes needs backport to 3.14 bugs and security fixes labels Nov 17, 2025
@ZeroIntensity
ZeroIntensity merged commit b362632 into python:mainNov 17, 2025
30 checks passed
@github-project-automationgithub-project-automationBot moved this from Todo to Done in Docs PRsNov 17, 2025
@ZeroIntensity
ZeroIntensity deleted the document-pyodict branch November 17, 2025 19:40
@miss-islington-app

Copy link
Copy Markdown

Thanks @ZeroIntensity for the PR 🌮🎉.. I'm working now to backport this PR to: 3.13, 3.14.
🐍🍒⛏🤖

miss-islington pushed a commit to miss-islington/cpython that referenced this pull request Nov 17, 2025
(cherry picked from commit b362632)
Co-authored-by: Peter Bierma <zintensitydev@gmail.com>
@bedevere-app

Copy link
Copy Markdown

GH-141677 is a backport of this pull request to the 3.14 branch.

@bedevere-appbedevere-appBot removed the needs backport to 3.14 bugs and security fixes label Nov 17, 2025
miss-islington pushed a commit to miss-islington/cpython that referenced this pull request Nov 17, 2025
(cherry picked from commit b362632)
Co-authored-by: Peter Bierma <zintensitydev@gmail.com>
@bedevere-app

Copy link
Copy Markdown

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

@bedevere-appbedevere-appBot removed the needs backport to 3.13 bugs and security fixes label Nov 17, 2025
ZeroIntensity added a commit that referenced this pull request Nov 17, 2025
gh-141004: Document `PyODict*` APIs (GH-141136)
(cherry picked from commit b362632)
Co-authored-by: Peter Bierma <zintensitydev@gmail.com>
ZeroIntensity added a commit that referenced this pull request Nov 17, 2025
gh-141004: Document `PyODict*` APIs (GH-141136)
(cherry picked from commit b362632)
Co-authored-by: Peter Bierma <zintensitydev@gmail.com>
StanFromIreland pushed a commit to StanFromIreland/cpython that referenced this pull request Dec 6, 2025
Sign up for freeto join this conversation on GitHub. Already have an account? Sign in to comment

Labels

docsDocumentation in the Doc dirskip news

Projects

Status: Done

Development

Successfully merging this pull request may close these issues.

2 participants

@ZeroIntensity@StanFromIreland