Skip to content

Commit cf2ecbc

Browse files
miss-islingtonsobolevnhugovk
authored
[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 01d970c) Co-authored-by: Nikita Sobolev <[email protected]> Co-authored-by: Hugo van Kemenade <[email protected]>
1 parent f7252f6 commit cf2ecbc

File tree

3 files changed

+15
-3
lines changed

3 files changed

+15
-3
lines changed

Doc/c-api/file.rst

+7-2
Original file line numberDiff line numberDiff line change
@@ -65,8 +65,13 @@ the :mod:`io` APIs instead.
6565
Overrides the normal behavior of :func:`io.open_code` to pass its parameter
6666
through the provided handler.
6767
68-
The handler is a function of type :c:expr:`PyObject *(\*)(PyObject *path,
69-
void *userData)`, where *path* is guaranteed to be :c:type:`PyUnicodeObject`.
68+
The handler is a function of type:
69+
70+
.. c:type:: Py_OpenCodeHookFunction
71+
72+
Equivalent of :c:expr:`PyObject *(\*)(PyObject *path,
73+
void *userData)`, where *path* is guaranteed to be
74+
:c:type:`PyUnicodeObject`.
7075
7176
The *userData* pointer is passed into the hook function. Since hook
7277
functions may be called from different runtimes, this pointer should not

Doc/c-api/object.rst

+8
Original file line numberDiff line numberDiff line change
@@ -19,6 +19,14 @@ Object Protocol
1919
to NotImplemented and return it).
2020

2121

22+
.. c:macro:: Py_PRINT_RAW
23+
24+
Flag to be used with multiple functions that print the object (like
25+
:c:func:`PyObject_Print` and :c:func:`PyFile_WriteObject`).
26+
If passed, these function would use the :func:`str` of the object
27+
instead of the :func:`repr`.
28+
29+
2230
.. c:function:: int PyObject_Print(PyObject *o, FILE *fp, int flags)
2331
2432
Print an object *o*, on file *fp*. Returns ``-1`` on error. The flags argument

Doc/tools/.nitignore

-1
Original file line numberDiff line numberDiff line change
@@ -5,7 +5,6 @@
55
Doc/c-api/arg.rst
66
Doc/c-api/descriptor.rst
77
Doc/c-api/exceptions.rst
8-
Doc/c-api/file.rst
98
Doc/c-api/float.rst
109
Doc/c-api/gcsupport.rst
1110
Doc/c-api/init.rst

0 commit comments

Comments
 (0)