Skip to content

gh-141004: Document remaining pyport.h utility macros #144279

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
ZeroIntensity merged 19 commits into from
Feb 4, 2026
Merged

gh-141004: Document remaining pyport.h utility macros #144279

Changes from 1 commit
Commits
Show all changes
19 commits
Select commit Hold shift + click to select a range
85d1c40
Document Py_ALIGNED
ZeroIntensity Jan 27, 2026
a0f0bda
Document Py_ARITHMETIC_RIGHT_SHIFT
ZeroIntensity Jan 27, 2026
0389e16
Add versionchanged.
ZeroIntensity Jan 27, 2026
38ed1e2
Document Py_CAN_START_THREADS
ZeroIntensity Jan 27, 2026
fbb93ab
Add versionadded.
ZeroIntensity Jan 27, 2026
9785f84
Document Py_FORCE_EXPANSION
ZeroIntensity Jan 27, 2026
5d84b69
Document Py_GCC_ATTRIBUTE.
ZeroIntensity Jan 27, 2026
fa005af
Document Py_LL and Py_ULL.
ZeroIntensity Jan 27, 2026
2630329
Document Py_SAFE_DOWNCAST.
ZeroIntensity Jan 27, 2026
d912569
Document Py_VA_COPY.
ZeroIntensity Jan 27, 2026
8437710
Fix Sphinx errors.
ZeroIntensity Jan 27, 2026
920ead5
Fix more stupid Sphinx problems.
ZeroIntensity Jan 27, 2026
ed7c53d
Fix my checker script.
ZeroIntensity Jan 27, 2026
62ac248
Apply suggestions from code review
ZeroIntensity Jan 28, 2026
c1ef33d
Fix warnings.
ZeroIntensity Jan 28, 2026
efb0c72
Add a backwards compatibility note.
ZeroIntensity Jan 28, 2026
bc735a6
Remove sentence about older versions.
ZeroIntensity Jan 29, 2026
aadcade
Update Doc/c-api/intro.rst
ZeroIntensity Feb 3, 2026
b91fbbe
Apply suggestions from code review
ZeroIntensity Feb 3, 2026
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
Prev Previous commit
Next Next commit
Remove sentence about older versions.
  • Loading branch information
@ZeroIntensity
ZeroIntensity committed Jan 29, 2026
commit bc735a667211c6ef8b2946441927a65261a51438
5 changes: 2 additions & 3 deletions Doc/c-api/intro.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -187,9 +187,8 @@
expensive operation to this macro. Instead, store the result as a
variable and then pass it.
Comment thread
ZeroIntensity marked this conversation as resolved.

*type* is the type of the expression. In modern versions of Python, this is
unused and only kept for backwards compatibility. Historically, *type* was
used to cast *integer*.
*type* is unused and only kept for backwards compatibility. Historically,
*type* was used to cast *integer*.

.. versionchanged:: 3.1

Expand Down Expand Up @@ -336,7 +335,7 @@
Cast *value* to type *smaller* from type *larger*, validating that no
information was lost.

On release builds of Python, this is roughly equivalent to

Check warning on line 338 in Doc/c-api/intro.rst

View workflow job for this annotation

GitHub Actions / Docs / Docs 

c:identifier reference target not found: value [ref.identifier]

Check warning on line 338 in Doc/c-api/intro.rst

View workflow job for this annotation

GitHub Actions / Docs / Docs 

c:identifier reference target not found: smaller [ref.identifier]
:c:expr:`(smaller) value` (in C++, ``static_cast<smaller>(value)`` will be
Comment thread
ZeroIntensity marked this conversation as resolved.
Outdated
used instead).

Expand Down
Loading