PyObject_DelItemString is not documented

[koyuki7w]

Documentation

PyObject_DelItemString is part of the limited C-API and is undocumented. This function was implemented in commit b0d71d0 , but no documentation was added.

Linked PRs

• gh-127954: Document PyObject_DelItemString #127986
• [3.13] gh-127954: Document PyObject_DelItemString (GH-127986) #128496
• [3.12] gh-127954: Document PyObject_DelItemString (GH-127986) #128497

[ZeroIntensity]

Thanks for tracking these down. You might also want to take a look at gh-118915 if you're interested in submitting some PRs :)

[picnixz]

For anyone interested in documenting this one: it's the same as PyObject_DelItem but instead of taking the key as a PyObject *, it takes the key as a const char *. We should just mention that the key is a UTF-8 encoded bytes string (see PyObject_HasAttrStringWithError for instance for a similar formulation when the parameter is a const char *).

[rruuaanng]

I want to ask, if I can complete it? It's documentation can be like at PyObject_HasAttrStringWithError :---)

[picnixz]

I'd wait a week in case @koyuki7w wanted to take it (they've be contributing to docs recently).

[koyuki7w]

@rruuaanng Yes, please complete and open PR.

[erlend-aasland]

Thanks for the report, Yuki; thanks for the PR, James.

Documentation added in…:

• gh-127954: Document PyObject_DelItemString #127986
• [3.13] gh-127954: Document PyObject_DelItemString (GH-127986) #128496
• [3.12] gh-127954: Document PyObject_DelItemString (GH-127986) #128497

Auto-merge enabled for the backports. Marking as resolved.