gh-127954: Document PyObject_DelItemString
#127986
Merged
Conversation
This file contains 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
rruuaanng
changed the title
PyObject_DelItemString function documentationPyObject_DelItemString function documentation
ZeroIntensity
added
needs backport to 3.12
Eclips4
approved these changes
Dec 16, 2024
picnixz
approved these changes
Dec 17, 2024
| @@ -492,6 +492,13 @@ Object Protocol | |||
| on failure. This is equivalent to the Python statement ``del o[key]``. | |||
|
|
|||
|
|
|||
| .. c:function:: int PyObject_DelItemString(PyObject *o, const char *key) | |||
|
|
|||
| This is the same as :c:func:`PyObject_DelItem`, but *key* is | |||
There was a problem hiding this comment.
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
-
"This is the same as" is sometimes used, but "Similar to [...], but" is a more common, and also more concise. ↩
erlend-aasland
changed the title
PyObject_DelItemString function documentationPyObject_DelItemString
erlend-aasland
approved these changes
Jan 4, 2025
This comment was marked as outdated.
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) <[email protected]>
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) <[email protected]>
|
GH-128496 is a backport of this pull request to the 3.13 branch. |
|
GH-128497 is a backport of this pull request to the 3.12 branch. |
erlend-aasland
pushed a commit
that referenced
this pull request
Jan 4, 2025
(cherry picked from commit 8ade153) Co-authored-by: RUANG (James Roy) <[email protected]>
erlend-aasland
pushed a commit
that referenced
this pull request
Jan 4, 2025
(cherry picked from commit 8ade153) Co-authored-by: RUANG (James Roy) <[email protected]>
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 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.
PyObject_DelItemStringis not documented #127954📚 Documentation preview 📚: https://cpython-previews--127986.org.readthedocs.build/