Skip to content

Conversation

@rruuaanng
Copy link
Contributor

@rruuaanngrruuaanng commented Dec 16, 2024

@bedevere-appbedevere-appbot added docs Documentation in the Doc dir skip news labels Dec 16, 2024
@rruuaanngrruuaanng changed the title gh-127954: Complete missing PyObject_DelItemString function documentationgh-127954: Add missing PyObject_DelItemString function documentationDec 16, 2024
@ZeroIntensityZeroIntensity added needs backport to 3.12 only security fixes needs backport to 3.13 bugs and security fixes labels Dec 16, 2024
Copy link
Member

@ZeroIntensityZeroIntensity left a comment

Choose a reason for hiding this comment

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

LGTM

.. c:function::intPyObject_DelItemString(PyObject *o, const char *key)
This is the same as :c:func:`PyObject_DelItem`, but *key* is
Copy link
Contributor

Choose a reason for hiding this comment

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

This is the canonical1 way to write it (git grep -i "similar to" Doc/c-api for inspiration):

Suggested change
This is the same as:c:func:`PyObject_DelItem`, but *key* is
Similar to:c:func:`PyObject_DelItem`, but *key* is

Footnotes

  1. "This is the same as" is sometimes used, but "Similar to [...], but" is a more common, and also more concise.

@erlend-aaslanderlend-aasland linked an issue Jan 4, 2025 that may be closed by this pull request
@erlend-aaslanderlend-aasland changed the title gh-127954: Add missing PyObject_DelItemString function documentationgh-127954: Document PyObject_DelItemStringJan 4, 2025
@erlend-aaslanderlend-aasland merged commit 8ade153 into python:mainJan 4, 2025
44 checks passed
@miss-islington-app

This comment was marked as outdated.

miss-islington pushed a commit to miss-islington/cpython that referenced this pull request Jan 4, 2025
(cherry picked from commit 8ade153) Co-authored-by: RUANG (James Roy) <rruuaanng@outlook.com>
miss-islington pushed a commit to miss-islington/cpython that referenced this pull request Jan 4, 2025
(cherry picked from commit 8ade153) Co-authored-by: RUANG (James Roy) <rruuaanng@outlook.com>
@bedevere-app
Copy link

GH-128496 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 Jan 4, 2025
@bedevere-app
Copy link

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

@bedevere-appbedevere-appbot removed the needs backport to 3.12 only security fixes label Jan 4, 2025
erlend-aasland pushed a commit that referenced this pull request Jan 4, 2025
(cherry picked from commit 8ade153) Co-authored-by: RUANG (James Roy) <rruuaanng@outlook.com>
erlend-aasland pushed a commit that referenced this pull request Jan 4, 2025
(cherry picked from commit 8ade153) Co-authored-by: RUANG (James Roy) <rruuaanng@outlook.com>
srinivasreddy pushed a commit to srinivasreddy/cpython that referenced this pull request Jan 6, 2025
srinivasreddy pushed a commit to srinivasreddy/cpython that referenced this pull request Jan 8, 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.

PyObject_DelItemString is not documented

6 participants

@rruuaanng@picnixz@erlend-aasland@ZeroIntensity@Eclips4@StanFromIreland