Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Documentation contains many TODOs #93

Open
2 tasks
d-lamb opened this issue Jan 4, 2019 · 0 comments
Open
2 tasks

Documentation contains many TODOs #93

d-lamb opened this issue Jan 4, 2019 · 0 comments

Comments

@d-lamb
Copy link

d-lamb commented Jan 4, 2019

I'm reading the documentation about POD parsers. The PDL project's current POD parser is written using Pod::Select. The documentation in Pod::Select says that it is legacy as of Perl 5.18 and to suggests using Pod::Simple for all things Pod. That is fine, but there are still many TODOs in the documentation for Pod::Simple, a core module:

  • The SYNOPSIS for Pod::Simple contains only a TODO (either it needs to be filled in or eliminated);
  • The documentation for Pod::Simple::Subclassing contains 8 TODOs, including at the top of the Events section (this seems like an important section?).

There may be others, but those are the ones I have come across so far.

jkeenan added a commit to jkeenan/pod-simple that referenced this issue Jul 17, 2024
Lifted from Pod::Simple::Subclassing.

Partially addresses GH perl-pod#93.
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

No branches or pull requests

1 participant