Skip to content

gh-141004: document the Python version adding each PyExpat_CAPI member - #160471

Merged
encukou merged 2 commits into
python:mainfrom
picnixz:docs/capi/expat-versionadded-141004
Oct 23, 2026
Merged

encukou merged 2 commits into
python:mainfrom
picnixz:docs/capi/expat-versionadded-141004

Conversation

@picnixz

@picnixz picnixz commented Oct 23, 2026 •

Copy link
Copy Markdown
Member

@picnixz
picnixz requested review from encukou and removed request for ZeroIntensity October 23, 2026 19:19
@bedevere-app bedevere-app Bot added docs Documentation in the Doc dir skip news labels Oct 23, 2026
@github-project-automation github-project-automation Bot moved this to Todo in Docs PRs Oct 23, 2026
@read-the-docs-community

read-the-docs-community Bot commented Oct 23, 2026 •

Copy link
Copy Markdown

Documentation build overview

📚 cpython-previews | 🛠️ Build #35366563 | 📁 Comparing a063ffe against main (897671b)

  🔍 Preview build  

6 files changed · ± 6 modified

± Modified

@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.

I think this is fine, but I suspect @encukou has some stronger opinions here.

Comment thread Doc/c-api/pyexpat.rst Outdated
Comment on lines +26 to +28
&& capi->MAJOR_VERSION == XML_MAJOR_VERSION
&& capi->MINOR_VERSION == XML_MINOR_VERSION
&& capi->MICRO_VERSION == XML_MICRO_VERSION

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.

This is something we weren't sure about. Is the version-checking necessary?
Does expat break ABI (even in minor versions)?

Copy link
Copy Markdown
Member Author

Choose a reason for hiding this comment

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

As discussed: I'm going to only suggest checking the magic number and size as the version checking may even be wrong for consumers (for us it's correct but not necessarily for others).

Comment thread Doc/c-api/pyexpat.rst
Comment thread Doc/c-api/pyexpat.rst Outdated

@encukou encukou 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.

Thank you!

@encukou
encukou merged commit e9445f6 into python:main Oct 23, 2026
30 checks passed
@github-project-automation github-project-automation Bot moved this from Todo to Done in Docs PRs Oct 23, 2026
@picnixz
picnixz deleted the docs/capi/expat-versionadded-141004 branch October 23, 2026 23:01
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

docs Documentation in the Doc dir skip news

Projects

Status: Done

Development

Successfully merging this pull request may close these issues.

3 participants