Skip to content

docs: modernize POD references and add SEE ALSO#61

Draft
toddr-bot wants to merge 1 commit intomainfrom
koan.toddr.bot/modernize-pod-docs
Draft

docs: modernize POD references and add SEE ALSO#61
toddr-bot wants to merge 1 commit intomainfrom
koan.toddr.bot/modernize-pod-docs

Conversation

@toddr-bot
Copy link
Copy Markdown
Collaborator

What

Modernize the POD documentation with three focused improvements.

Why

The BUGS section still references RT (Request Tracker) for filing issues, but
the project moved to GitHub years ago. New users hitting a bug would follow a
dead link. The module also lacked a SEE ALSO section, which hurts
discoverability on MetaCPAN.

How

  • Replace "open an RT ticket" → link to GitHub Issues
  • Add =head1 SEE ALSO with stty(1), POSIX, and Term::ReadKey
  • Fix "PERL" → "Perl" in the DESCRIPTION (consistent with Perl community style)
  • Regenerate README.md from updated POD

Testing

All 147 tests pass including POD and POD coverage checks (RELEASE_TESTING=1 make test).

🤖 Generated with Claude Code

…sing

- Replace outdated "open an RT ticket" with GitHub Issues URL
- Add SEE ALSO section linking stty(1), POSIX, and Term::ReadKey
- Change "PERL" to "Perl" in module description
- Regenerate README.md from updated POD

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