search

metacpan / metacpan-api

A free, open API for everything you want to know about CPAN
http://www.metacpan.org/
Other
289 stars 196 forks source link

pod markup should be parsed out of abstracts #930

Open karenetheridge opened 4 years ago

karenetheridge commented 4 years ago

Reference -- https://github.com/rjbs/Dist-Zilla/pull/647

If there is pod markup in a 'DESCRIPTION' line of a module's pod, this should either be stripped or converted to html instead of left alone, when generating the abstract line for a distribution's table of contents.

oalders commented 4 years ago

Do you have an example release we could test this against?

davel commented 4 years ago

If there is pod markup in a 'DESCRIPTION' line of a module's pod, this should either be stripped or converted to html instead of left alone, when generating the abstract line for a distribution's table of contents.

Do you mean the NAME section?

This release attempts to use E<...> in the abstracts, https://metacpan.org/release/DLAMBLEY/App-RetroPAN-0.01

image

I've not looked for an example. but it also looks like metacpan won't extract the abstract from magic comments. Dist::Zilla does /^\s*#+\s*ABSTRACT:[ \t]*(\S.*)$/m on the source if it cannot find one in the POD.

karenetheridge commented 4 years ago

Do you mean the NAME section?

Yes, thanks.

it also looks like metacpan won't extract the abstract from magic comments

I don't think it should. That information should always be present in the 'NAME' section of built dists.