◐ Shell
reader mode source ↗
Skip to content

gh-141004: Document Py_HASH_* macros#141205

Merged
picnixz merged 7 commits into
python:mainfrom
picnixz:doc/capi/hash-141004
Nov 7, 2025
Merged

gh-141004: Document Py_HASH_* macros#141205
picnixz merged 7 commits into
python:mainfrom
picnixz:doc/capi/hash-141004

Conversation

@picnixz

@picnixz picnixz commented Nov 7, 2025 •
edited
Loading

Copy link
Copy Markdown
Member

This one is much more tricky because Py_HASH_EXTERNAL was never documented and not really supported in the configure script. It would require user-defined defines and other hacks.

What I can do is remove the EXTERNAL docs and make a separate bugfix.

📚 Documentation preview 📚: https://cpython-previews--141205.org.readthedocs.build/

@bedevere-app bedevere-app Bot mentioned this pull request Nov 7, 2025
Open
@picnixz picnixz requested a review from ZeroIntensity November 7, 2025 16:23
ZeroIntensity
ZeroIntensity approved these changes Nov 7, 2025
View reviewed changes

@ZeroIntensity ZeroIntensity left a comment

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

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

Hide comment

Thanks!

@picnixz picnixz requested a review from ZeroIntensity November 7, 2025 18:10
@picnixz

picnixz commented Nov 7, 2025

Copy link
Copy Markdown
Member Author

I decided to add the two blank lines around constants. Ideally I wanted sections, but I think two blank lines are better for reading the document. With so many versionadded, it's easy to get lost.

@ZeroIntensity

ZeroIntensity commented Nov 7, 2025

Copy link
Copy Markdown
Member

I already approved this, no need to request. I'm not too familiar with this area, so I'm basically just trusting that you know what you're doing in terms of content. The format and whatnot look fine.

Hide details View details @picnixz picnixz merged commit 3989e12 into python:main Nov 7, 2025
28 checks passed
@picnixz picnixz deleted the doc/capi/hash-141004 branch November 7, 2025 18:25
@picnixz

picnixz commented Nov 7, 2025 •
edited
Loading

Copy link
Copy Markdown
Member Author

Well.... I included a typo :D (but that's because we have confusing names!!) I will fix it tomorrow but it will be fast (so I won't backport it yet). I knew I shouldn't have left my dev session...

picnixz added a commit to picnixz/cpython that referenced this pull request Nov 8, 2025
@picnixz
[3.14] pythongh-141004: Document Py_HASH_* macros (pythonGH-141205) …
fdd21a6 
(cherry picked from commit 3989e12)

Co-authored-by: Bénédikt Tran <10796600+picnixz@users.noreply.github.com>
@picnixz picnixz added needs backport to 3.13 bugs and security fixes needs backport to 3.14 bugs and security fixes labels Nov 8, 2025
@miss-islington-app

miss-islington-app Bot commented Nov 8, 2025

Copy link
Copy Markdown

Thanks @picnixz for the PR 🌮🎉.. I'm working now to backport this PR to: 3.13.
🐍🍒⛏🤖

@miss-islington-app

miss-islington-app Bot commented Nov 8, 2025

Copy link
Copy Markdown

Thanks @picnixz for the PR 🌮🎉.. I'm working now to backport this PR to: 3.14.
🐍🍒⛏🤖

miss-islington pushed a commit to miss-islington/cpython that referenced this pull request Nov 8, 2025
@picnixz @miss-islington
pythongh-141004: Document Py_HASH_* macros (pythonGH-141205) …
8f05e9d 
(cherry picked from commit 3989e12)

Co-authored-by: Bénédikt Tran <10796600+picnixz@users.noreply.github.com>
@bedevere-app

bedevere-app Bot commented Nov 8, 2025

Copy link
Copy Markdown

GH-141224 is a backport of this pull request to the 3.13 branch.

@bedevere-app bedevere-app Bot removed the needs backport to 3.13 bugs and security fixes label Nov 8, 2025
miss-islington pushed a commit to miss-islington/cpython that referenced this pull request Nov 8, 2025
@picnixz @miss-islington
pythongh-141004: Document Py_HASH_* macros (pythonGH-141205) …
4872b0e 
(cherry picked from commit 3989e12)

Co-authored-by: Bénédikt Tran <10796600+picnixz@users.noreply.github.com>
@bedevere-app

bedevere-app Bot commented Nov 8, 2025

Copy link
Copy Markdown

GH-141225 is a backport of this pull request to the 3.14 branch.

@bedevere-app bedevere-app Bot removed the needs backport to 3.14 bugs and security fixes label Nov 8, 2025
picnixz added a commit that referenced this pull request Nov 8, 2025
@miss-islington @picnixz
[3.14] gh-141004: Document Py_HASH_* macros (GH-141205) (#141225) …
de00dde 
* gh-141004: Document `Py_HASH_*` macros (GH-141205)

(cherry picked from commit 3989e12)
(cherry picked from commit 8cec3d3)

Co-authored-by: Bénédikt Tran <10796600+picnixz@users.noreply.github.com>
picnixz added a commit that referenced this pull request Nov 8, 2025
@miss-islington @picnixz
[3.13] gh-141004: Document Py_HASH_* macros (GH-141205) (#141224) …
a728f7f 
* gh-141004: Document `Py_HASH_*` macros (GH-141205)

(cherry picked from commit 3989e12)
(cherry picked from commit 8cec3d3)

Co-authored-by: Bénédikt Tran <10796600+picnixz@users.noreply.github.com>
StanFromIreland pushed a commit to StanFromIreland/cpython that referenced this pull request Dec 6, 2025
@picnixz @StanFromIreland
pythongh-141004: Document Py_HASH_* macros (python#141205)
958f9d8
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

@erlend-aasland erlend-aasland Awaiting requested review from erlend-aasland

@corona10 corona10 Awaiting requested review from corona10

@AA-Turner AA-Turner

@emmatyping emmatyping Awaiting requested review from emmatyping

@ZeroIntensity ZeroIntensity Awaiting requested review from ZeroIntensity ZeroIntensity is a code owner

Assignees

No one assigned

Labels

skip news

Projects

None yet

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

2 participants

@picnixz @ZeroIntensity