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

gh-127954: Document `PyObject_DelItemString` by rruuaanng · Pull Request #127986 · python/cpython · GitHub

  1. python
  2. cpython

Repository navigation

gh-127954: Document PyObject_DelItemString #127986

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
erlend-aasland merged 1 commit into from
Jan 4, 2025
Conversation 10 Commits 1 Checks 0 Files changed
Merged

gh-127954: Document PyObject_DelItemString #127986

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension .rst  (1) All 1 file type selected
Viewed files
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Unified
Split
Hide whitespace
Diff view
Unified
Split
Hide whitespace
7 changes: 7 additions & 0 deletions Doc/c-api/object.rst
Show comments
View file
Open in desktop
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
Original file line number Diff line number Diff line change
Expand Up @@ -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

erlend-aasland Jan 4, 2025

Copy link
Copy Markdown
Contributor

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

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. ↩
specified as a :c:expr:`const char*` UTF-8 encoded bytes string,
Comment thread
Eclips4 marked this conversation as resolved.
rather than a :c:expr:`PyObject*`.


.. c:function:: PyObject* PyObject_Dir(PyObject *o)

This is equivalent to the Python expression ``dir(o)``, returning a (possibly
Expand Down
Back | FazBrowse Home | New Git URL