mirror of
https://github.com/python/cpython.git
synced 2025-08-10 03:49:18 +00:00
[3.12] gh-101100: Fix sphinx warnings in c-api/file.rst
(GH-114546) (#114584)
* gh-101100: Fix sphinx warnings in `c-api/file.rst` (GH-114546)
(cherry picked from commit 01d970c1b8
)
Co-authored-by: Nikita Sobolev <mail@sobolevn.me>
Co-authored-by: Hugo van Kemenade <1324225+hugovk@users.noreply.github.com>
This commit is contained in:
parent
f7252f6831
commit
cf2ecbc514
3 changed files with 15 additions and 3 deletions
|
@ -65,8 +65,13 @@ the :mod:`io` APIs instead.
|
|||
Overrides the normal behavior of :func:`io.open_code` to pass its parameter
|
||||
through the provided handler.
|
||||
|
||||
The handler is a function of type :c:expr:`PyObject *(\*)(PyObject *path,
|
||||
void *userData)`, where *path* is guaranteed to be :c:type:`PyUnicodeObject`.
|
||||
The handler is a function of type:
|
||||
|
||||
.. c:type:: Py_OpenCodeHookFunction
|
||||
|
||||
Equivalent of :c:expr:`PyObject *(\*)(PyObject *path,
|
||||
void *userData)`, where *path* is guaranteed to be
|
||||
:c:type:`PyUnicodeObject`.
|
||||
|
||||
The *userData* pointer is passed into the hook function. Since hook
|
||||
functions may be called from different runtimes, this pointer should not
|
||||
|
|
|
@ -19,6 +19,14 @@ Object Protocol
|
|||
to NotImplemented and return it).
|
||||
|
||||
|
||||
.. c:macro:: Py_PRINT_RAW
|
||||
|
||||
Flag to be used with multiple functions that print the object (like
|
||||
:c:func:`PyObject_Print` and :c:func:`PyFile_WriteObject`).
|
||||
If passed, these function would use the :func:`str` of the object
|
||||
instead of the :func:`repr`.
|
||||
|
||||
|
||||
.. c:function:: int PyObject_Print(PyObject *o, FILE *fp, int flags)
|
||||
|
||||
Print an object *o*, on file *fp*. Returns ``-1`` on error. The flags argument
|
||||
|
|
|
@ -5,7 +5,6 @@
|
|||
Doc/c-api/arg.rst
|
||||
Doc/c-api/descriptor.rst
|
||||
Doc/c-api/exceptions.rst
|
||||
Doc/c-api/file.rst
|
||||
Doc/c-api/float.rst
|
||||
Doc/c-api/gcsupport.rst
|
||||
Doc/c-api/init.rst
|
||||
|
|
Loading…
Add table
Add a link
Reference in a new issue