Skip to content

docs: modernize Parser.pm POD with supported constructs reference#42

Draft
toddr-bot wants to merge 1 commit intocpan-authors:mainfrom
toddr-bot:koan.toddr.bot/cleanup-parser-pod
Draft

docs: modernize Parser.pm POD with supported constructs reference#42
toddr-bot wants to merge 1 commit intocpan-authors:mainfrom
toddr-bot:koan.toddr.bot/cleanup-parser-pod

Conversation

@toddr-bot
Copy link
Copy Markdown
Collaborator

@toddr-bot toddr-bot commented Apr 12, 2026

What

Replaces dead POD sections with a useful quick-reference of all supported regex constructs.

Why

The EXTENSIONS section listed hypothetical modules from 2004 that were never built. The HISTORY section duplicated the Changes file with 22-year-old changelog entries. Neither helped users understand what the module actually supports today.

How

  • Removed EXTENSIONS (6 never-built module descriptions) and HISTORY (4 ancient releases)
  • Added SUPPORTED CONSTRUCTS: categorized listing of all parsed regex syntax (grouping, quantifiers, assertions, lookaround, character classes, Unicode properties, escapes, backrefs, flags, conditionals, verbs, recursion, script runs)
  • Documented the named_captures() method (was implemented but missing from POD)
  • Rewrote CAVEATS to document the two-pass parsing model and opaque constructs

Net: -201 lines of dead weight, +76 lines of useful reference. No code changes.

Testing

  • podchecker passes clean
  • Full test suite passes

Quality Report

Changes: 1 file changed, 76 insertions(+), 201 deletions(-)

Code scan: clean

Tests: passed (OK)

Branch hygiene: clean

Generated by Kōan post-mission quality pipeline

… sections

Replace the EXTENSIONS section (hypothetical modules from 2004 that were
never built) and HISTORY section (ancient changelog duplicated in Changes)
with a comprehensive SUPPORTED CONSTRUCTS reference listing all parsed
regex syntax. Document the named_captures() method. Clean up CAVEATS to
document the two-pass parsing model and opaque constructs.

Net effect: ~150 lines of dead weight removed, replaced with a useful
quick-reference for users evaluating or using the module.

Co-Authored-By: Claude Opus 4.6 <noreply@anthropic.com>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant