https://github.com/python/cpython/commit/4c34b7ebf15d4775323936278ab6ee9900671fa7
commit: 4c34b7ebf15d4775323936278ab6ee9900671fa7
branch: main
author: Peter Bierma <[email protected]>
committer: encukou <[email protected]>
date: 2026-10-19T23:49:42+02:00
summary:
gh-141004: Document missing `pyport.h` macros (GH-159719)
files:
M Doc/c-api/float.rst
M Doc/c-api/intro.rst
M Tools/check-c-api-docs/ignored_c_api.txt
diff --git a/Doc/c-api/float.rst b/Doc/c-api/float.rst
index c484b3e5bdb5132..8a944402ed683a5 100644
--- a/Doc/c-api/float.rst
+++ b/Doc/c-api/float.rst
@@ -214,7 +214,7 @@ Pack functions
The pack routines write 2, 4 or 8 bytes, starting at *p*. *le* is an
:c:expr:`int` argument, non-zero if you want the bytes string in little-endian
format (exponent last, at ``p+1``, ``p+3``, or ``p+6`` and ``p+7``), zero if
you
-want big-endian format (exponent first, at *p*). Use the
:c:macro:`!PY_LITTLE_ENDIAN`
+want big-endian format (exponent first, at *p*). Use the
:c:macro:`PY_LITTLE_ENDIAN`
constant to select the native endian: it is equal to ``0`` on big
endian processor, or ``1`` on little endian processor.
@@ -240,7 +240,7 @@ Unpack functions
The unpack routines read 2, 4 or 8 bytes, starting at *p*. *le* is an
:c:expr:`int` argument, non-zero if the bytes string is in little-endian format
(exponent last, at ``p+1``, ``p+3`` or ``p+6`` and ``p+7``), zero if big-endian
-(exponent first, at *p*). Use the :c:macro:`!PY_LITTLE_ENDIAN` constant to
+(exponent first, at *p*). Use the :c:macro:`PY_LITTLE_ENDIAN` constant to
select the native endian: it is equal to ``0`` on big endian processor, or
``1``
on little endian processor.
diff --git a/Doc/c-api/intro.rst b/Doc/c-api/intro.rst
index 701d2a31b8c9059..258135a234cc50d 100644
--- a/Doc/c-api/intro.rst
+++ b/Doc/c-api/intro.rst
@@ -299,6 +299,12 @@ Numeric utilities
Argument must be a character or an integer in the range [-128, 127] or [0,
255]. This macro returns ``c`` cast to an ``unsigned char``.
+.. c:macro:: PY_BIG_ENDIAN
+ PY_LITTLE_ENDIAN
+
+ Constants describing the byte order of the platform that Python was built
+ for. Exactly one of them is ``1`` and the other is ``0``.
+
Assertion utilities
^^^^^^^^^^^^^^^^^^^
@@ -916,8 +922,13 @@ use them.
A signed integral type such that ``sizeof(Py_ssize_t) == sizeof(size_t)``.
C99 doesn't define such a thing directly (size_t is an unsigned integral
type).
- See :pep:`353` for details. ``PY_SSIZE_T_MAX`` is the largest positive value
- of type :c:type:`Py_ssize_t`.
+ See :pep:`353` for details.
+
+.. c:macro:: PY_SSIZE_T_MAX
+ PY_SSIZE_T_MIN
+
+ The limit values (largest positive one and smallest negative one,
+ respecitvely) of type :c:type:`Py_ssize_t`.
.. _api-exceptions:
diff --git a/Tools/check-c-api-docs/ignored_c_api.txt
b/Tools/check-c-api-docs/ignored_c_api.txt
index af7b2772ef5e085..1eb6806b83d5cd0 100644
--- a/Tools/check-c-api-docs/ignored_c_api.txt
+++ b/Tools/check-c-api-docs/ignored_c_api.txt
@@ -26,7 +26,6 @@ PyExpat_CAPSULE_NAME
# pyport.h
PYLONG_BITS_IN_DIGIT
PY_DWORD_MAX
-PY_BIG_ENDIAN
# cpython/methodobject.h
PyCFunction_GET_CLASS
# cpython/descrobject.h
_______________________________________________
Python-checkins mailing list -- [email protected]
To unsubscribe send an email to [email protected]
https://mail.python.org/mailman3//lists/python-checkins.python.org
Member address: [email protected]
