Skip to content

gh-102595: Document PyObject_Format c-api function #102596

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 3 commits into from
Mar 21, 2023
Merged

gh-102595: Document PyObject_Format c-api function #102596

Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
f0059bd
gh-102595: Document `PyObject_Format` c-api function
sobolevn Mar 11, 2023
5ca5977
Update Doc/c-api/object.rst
sobolevn Mar 11, 2023
fe429a0
Update Doc/c-api/object.rst
JelleZijlstra Mar 11, 2023
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
9 changes: 9 additions & 0 deletions Doc/c-api/object.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -179,6 +179,15 @@ Object Protocol
If *o1* and *o2* are the same object, :c:func:`PyObject_RichCompareBool`
will always return ``1`` for :const:`Py_EQ` and ``0`` for :const:`Py_NE`.

.. c:function:: PyObject* PyObject_Format(PyObject *obj, PyObject *format_spec)
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Weird that we're inconsistent in putting the space before or after the *, but the next two functions do the same thing.

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

The relevant style guide would be PEP 7, but it says nothing about this issue. All the examples use PyObject *x, though.


Format *obj* using *format_spec*. This is equivalent to the Python
expression ``format(obj, format_spec)``.

*format_spec* may be ``NULL``. In this case the call is equivalent
to ``format(obj)``.
Returns the formatted string on success, ``NULL`` on failure.

.. c:function:: PyObject* PyObject_Repr(PyObject *o)

.. index:: builtin: repr
Expand Down