Broken pod for perl modules
Nobody has claimed this yet.
- Dominant language
- Clojure
- Stars
- 644
- Forks
- 62
- PR merge metrics
- No merged PRs in 30d
Description
There are several missing newlines before a header:
- https://metacpan.org/release/INGY/YAMLScript-0.1.91/source/lib/YAMLScript.pod#L15
- https://metacpan.org/dist/Alien-YAMLScript/source/lib/Alien/YAMLScript.pod#L16
As a result those headers are not rendered as headers.
Another problem is here:
https://metacpan.org/dist/YAMLScript-Lingy/source/lib/YAMLScript/Lingy.pod#L7
That's the manpage for YAMLScript::Lingy, but the header says YAMLScript - Programming in YAML. It should say
YAMLScript::Lingy - Programming in YAML
Currently it is indexed wrongly, so https://metacpan.org/pod/YAMLScript does not link to https://metacpan.org/dist/YAMLScript but to https://metacpan.org/dist/YAMLScript-Lingy
I can't find any of those things in the git repository, so I can't offer a PR to fix this.
Contributor guide
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
Research direction
Search the repository for the POD sources corresponding to lib/YAMLScript.pod, lib/Alien/YAMLScript.pod, and lib/YAMLScript/Lingy.pod; the issue reports that these files are not currently easy to find. Check the referenced MetaCPAN lines and ensure headers render correctly, with the Lingy manpage named YAMLScript::Lingy. Done means the generated or published manpages index to the intended distributions.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- perl
- Domain
- documentation
- Issue type
- Documentation
- Difficulty
- 3/5
- Estimated time
- 1-2 days
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 35/100