https://github.com/python/cpython/commit/170bf7951e19ad2be608c9a377cecd96ac40e25c
commit: 170bf7951e19ad2be608c9a377cecd96ac40e25c
branch: 3.11
author: Miss Islington (bot) <31488909+miss-isling...@users.noreply.github.com>
committer: hugovk <1324225+hug...@users.noreply.github.com>
date: 2024-01-26T03:02:49-07:00
summary:
[3.11] gh-101100: Fix sphinx warnings in `c-api/file.rst` (GH-114546) (#114585)
Co-authored-by: Nikita Sobolev <m...@sobolevn.me>
Co-authored-by: Hugo van Kemenade <1324225+hug...@users.noreply.github.com>
files:
M Doc/c-api/file.rst
M Doc/c-api/object.rst
M Doc/tools/.nitignore
diff --git a/Doc/c-api/file.rst b/Doc/c-api/file.rst
index b36c800e00444a..0a03841e467cad 100644
--- a/Doc/c-api/file.rst
+++ b/Doc/c-api/file.rst
@@ -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
diff --git a/Doc/c-api/object.rst b/Doc/c-api/object.rst
index 54e9733b40c7b6..32f74fb20c7f92 100644
--- a/Doc/c-api/object.rst
+++ b/Doc/c-api/object.rst
@@ -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
diff --git a/Doc/tools/.nitignore b/Doc/tools/.nitignore
index eca771d8a1b418..199c367a74b08a 100644
--- a/Doc/tools/.nitignore
+++ b/Doc/tools/.nitignore
@@ -4,7 +4,6 @@
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
@@ -12,7 +11,6 @@ Doc/c-api/init_config.rst
Doc/c-api/intro.rst
Doc/c-api/memoryview.rst
Doc/c-api/module.rst
-Doc/c-api/object.rst
Doc/c-api/stable.rst
Doc/c-api/structures.rst
Doc/c-api/sys.rst
_______________________________________________
Python-checkins mailing list -- python-checkins@python.org
To unsubscribe send an email to python-checkins-le...@python.org
https://mail.python.org/mailman3/lists/python-checkins.python.org/
Member address: arch...@mail-archive.com
