Commitaf83cde

committed

gh-101100: Fix sphinx warnings inc-api/file.rst

1 parentc63c614 commitaf83cdeCopy full SHA for af83cde

File tree

+13

-4

lines changed

+13

-4

lines changed

Lines changed: 6 additions & 3 deletions

Original file line number	Diff line number	Diff line change
@@ -65,8 +65,12 @@ the :mod:`io` APIs instead.
`65`	`65`	Overrides the normal behavior of :func:`io.open_code` to pass its parameter
`66`	`66`	`through the provided handler.`
`67`	`67`
`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:c:type:`PyUnicodeObject`.
`70`	`74`
`71`	`75`	`The userData pointer is passed into the hook function. Since hook`
`72`	`76`	`functions may be called from different runtimes, this pointer should not`
@@ -87,7 +91,6 @@ the :mod:`io` APIs instead.
`87`	`91`	`..versionadded::3.8`
`88`	`92`
`89`	`93`
`90`		`-`
`91`	`94`	`..c:function::intPyFile_WriteObject(PyObject obj, PyObject p, int flags)`
`92`	`95`
`93`	`96`	`..index::single: Py_PRINT_RAW`

Lines changed: 7 additions & 0 deletions

Original file line number	Diff line number	Diff line change
`@@ -19,6 +19,13 @@ Object Protocol`
`19`	`19`	`to NotImplemented and return it).`
`20`	`20`
`21`	`21`
	`22`	`+..c:macro:: Py_PRINT_RAW`
	`23`	`+`
	`24`	+ Flag to be used with multiple functions that print the object (like:c:func:`PyObject_Print` and:c:func:`PyFile_WriteObject`).
	`25`	+ If passed, these function would use the:func:`str` of the object
	`26`	+ instead of the:func:`repr`.
	`27`	`+`
	`28`	`+`
`22`	`29`	`..c:function::intPyObject_Print(PyObject o, FILE fp, int flags)`
`23`	`30`
`24`	`31`	Print an object o, on file fp. Returns ``-1`` on error. The flags argument

Lines changed: 0 additions & 1 deletion

Comments

(0)