gh-107298: Fix numerous ref errors and typos in the C API docs #108258
Conversation
serhiy-storchaka
added
needs backport to 3.11
serhiy-storchaka
force-pushed
the
docs-capi-refs
branch
from
04ff27d to
195605c
Compare
serhiy-storchaka
force-pushed
the
docs-capi-refs
branch
from
195605c to
050933c
Compare
| that if *filename* is not ``NULL``, it is decoded from the filesystem | ||
| encoding (:func:`os.fsdecode`) and passed to the constructor of | ||
| :exc:`OSError` as a third parameter to be used to define the | ||
| :attr:`!filename` attribute of the exception instance. |
There was a problem hiding this comment.
I'm not sure if Doc/c-api/exceptions.rst changes are related or not? They don't seem to fix Sphinx warnings.
There was a problem hiding this comment.
Both descriptions referred non-existing function
PyObject* PyErr_SetFromWindowsErrWithFilenameObject(int ierr, PyObject *filenameObject);There is no, and never was such function.
So I rewrote the descriptions by referring other functions, using descriptions of other functions which add the filename parameter as an example.
It fixes 2 of 10 warnings in Doc/c-api/exceptions.rst.
There was a problem hiding this comment.
Oh I didn't notice, ok. Well, I approved your PR ;-)
|
Thanks @serhiy-storchaka for the PR 🌮🎉.. I'm working now to backport this PR to: 3.11, 3.12. |
|
Sorry, @serhiy-storchaka, I could not cleanly backport this to |
|
GH-108284 is a backport of this pull request to the 3.12 branch. |
…ythonGH-108258) (cherry picked from commit d7202e4) Co-authored-by: Serhiy Storchaka <[email protected]>
…I docs (pythonGH-108258). (cherry picked from commit d7202e4) Co-authored-by: Serhiy Storchaka <[email protected]>
|
GH-108290 is a backport of this pull request to the 3.11 branch. |
…GH-108258) (#108284) gh-107298: Fix numerous ref errors and typos in the C API docs (GH-108258) (cherry picked from commit d7202e4) Co-authored-by: Serhiy Storchaka <[email protected]>
…GH-108258) (#108290) (cherry picked from commit d7202e4)
📚 Documentation preview 📚: https://cpython-previews--108258.org.readthedocs.build/