Skip to content

Conversation

plicease
Copy link
Contributor

This indents the code blocks in the POD, which will make them easier to read.

@kamelkev
Copy link
Owner

kamelkev commented Jan 1, 2020

Not sure I follow what's going on here. Is this a preference thing? Or is this invoking some sort of behavior in a viewer or editor?

@plicease
Copy link
Contributor Author

plicease commented Jan 1, 2020

The code blocks in your POD are very hard to read when rendered in HTML see:

https://metacpan.org/pod/CSS::Inliner

Normally in Perl documentation code blocks are rendered in a fixed width font by putting them in a so-called "literal" block. This visibly separates them from the commentary, and makes it easier to read. It also means that extra line breaks don't get inserted if the line is long or if the screen width is narrow. Just one example Try::Tiny:

https://metacpan.org/pod/Try::Tiny#SYNOPSIS

Repository owner deleted a comment from William0Friend Mar 1, 2024
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.

2 participants