docs: fix Doctype handler Internal parameter documentation#265
Merged
Conversation
The Doctype handler documentation in Parser.pm incorrectly described the Internal parameter as a string containing the internal subset. In reality, the XS code (doctypeStart) passes PL_sv_yes/PL_sv_no — a boolean indicating whether an internal subset exists. This matches the correct documentation already in Expat.pm. Also fix DoctypeFin handler parameter name from (Parser) to (Expat) for consistency with all other handlers in Parser.pm, and add missing "true" in Expat.pm isname() method documentation. Co-Authored-By: Claude Opus 4.6 <noreply@anthropic.com>
Codecov Report✅ All modified and coverable lines are covered by tests. Additional details and impacted files@@ Coverage Diff @@
## main #265 +/- ##
=======================================
Coverage 75.73% 75.73%
=======================================
Files 1 1
Lines 1092 1092
Branches 342 342
=======================================
Hits 827 827
Misses 59 59
Partials 206 206
Flags with carried forward coverage won't be shown. Click here to find out more. ☔ View full report in Codecov by Sentry. 🚀 New features to boost your workflow:
|
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
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.
What
Fix incorrect documentation of the Doctype handler's Internal parameter, plus two minor POD consistency issues.
Why
Parser.pm described Internal as "the internal subset, given as a string" with detailed content — but the XS code (
doctypeStartat Expat.xs:842) actually pushesPL_sv_yes/PL_sv_no. It's a boolean indicating whether an internal subset exists, not its content. Expat.pm had the correct description all along.How
(Parser)to(Expat)— every other handler in Parser.pm uses(Expat)isname()method docs ("returns if" → "returns true if")Testing
make testpasses — all existing tests pass. These are POD-only changes with no behavioral impact.🤖 Generated with Claude Code