develooper Front page | perl.perl5.porters | Postings from June 2022

Re: Pre-RFC: images in Pod

Thread Previous | Thread Next
Neil Bowers
June 11, 2022 07:25
Re: Pre-RFC: images in Pod
Message ID:
Brett asked:
> Cool! So why are we discussing this, then?

Curtis replied:
> Because POD is used in places other than MetaCPAN, and it's output in formats other than HTML.

If you want to include diagrams in your CPAN distribution’s documentation, right now you’ve to get it online somewhere. There are plenty of options, such imgur (just picking an example that I’ve used), but now one of your distribution’s assets is not bundled with it. You _could_ include it in the dist, put your dist on github and use a raw content URL, but that’s a bit nasty to be explaining to casual CPAN authors.

And your diagrams might evolve over releases. Being able to bundle images in the distribution, knowing that the CPAN ecosystem can handle them, means you don’t need to worry about versioning the images – the right version is included for the version that a user is looking at.


Thread Previous | Thread Next Perl Programming lists via nntp and http.
Comments to Ask Bjørn Hansen at | Group listing | About