gh-141004: document pyexpat C API
#141259
Open
+243
−4
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
picnixz
force-pushed
the
docs/capi/expat-141004
branch
from
6164db5 to
dc77ab0
Compare
picnixz
force-pushed
the
docs/capi/expat-141004
branch
from
dc77ab0 to
5b857a4
Compare
Member
ZeroIntensity
left a comment
ZeroIntensity
left a comment
There was a problem hiding this comment.
Thanks for working on these!
Comment on lines
+67
to
+68
| static inline int | ||
| PyExpat_CheckCompatibility(struct PyExpat_CAPI *api) |
Member
There was a problem hiding this comment.
Eek, this looks like a new feature. We can add this for 3.15, but we should instead document the recipe for older versions.
Comment on lines
+227
to
+247
| nitpick_ignore += [ | ||
| ("c:identifier", "XML_Bool"), | ||
| ("c:identifier", "XML_Char"), | ||
| ("c:identifier", "XML_CharacterDataHandler"), | ||
| ("c:identifier", "XML_CommentHandler"), | ||
| ("c:identifier", "XML_DefaultHandler"), | ||
| ("c:identifier", "XML_Encoding"), | ||
| ("c:identifier", "XML_EndElementHandler"), | ||
| ("c:identifier", "XML_EndNamespaceDeclHandler"), | ||
| ("c:identifier", "XML_Error"), | ||
| ("c:identifier", "XML_LChar"), | ||
| ("c:identifier", "XML_Memory_Handling_Suite"), | ||
| ("c:identifier", "XML_Parser"), | ||
| ("c:identifier", "XML_ProcessingInstructionHandler"), | ||
| ("c:identifier", "XML_Size"), | ||
| ("c:identifier", "XML_StartDoctypeDeclHandler"), | ||
| ("c:identifier", "XML_StartElementHandler"), | ||
| ("c:identifier", "XML_StartNamespaceDeclHandler"), | ||
| ("c:identifier", "XML_Status"), | ||
| ("c:identifier", "XML_UnknownEncodingHandler"), | ||
| ] |
Member
There was a problem hiding this comment.
Out of curiosity, why isn't Sphinx happy with these?
| XML_Parser parser,\ | ||
| unsigned long hash_salt) | ||
| Might be NULL for Expat versions prior to 2.1.0. |
Member
There was a problem hiding this comment.
Up to you, but I'd prefer that we use inline code blocks for NULL.
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
The Expat C API does not store a global variable as other C APIs and instead prefer consumers to add both the capsule and the C API pointer in the consumer's state. I don't really llike this but it's probably the best
📚 Documentation preview 📚: https://cpython-previews--141259.org.readthedocs.build/