Skip to content

Conversation

@t-a-k
Copy link
Contributor

@t-a-k t-a-k commented Apr 11, 2025

The description of -M/-m switches in perlrun.pod used to have the constructs like C<use> I<module>C<;>, but this was rendered as separate blocks of text.
C<use I<module> ... will be rendered as a single block of code and looks better. I think.


  • This set of changes does not require a perldelta entry.

…>" in the description of -m/-M switches

"C<use I<module> ...>" will be rendered as a single <code> block
and (I think) it looks better than the previous "C<use> I<module> ...".
which would be rendered as separate blocks.
@jkeenan
Copy link
Contributor

jkeenan commented Apr 11, 2025

And you, dear reader of the pull requests queue, were wondering when your next opportunity for bikeshedding would come by ... well, here it is!

I'm attaching 4 .png files which represent:

  • the current output of running blead's version of pod/perlrun.pod through pod2man;

current man perlrun

  • the branch output of running the pull request's version of pod/perlrun.pod through pod2man;

branch man perlrun

  • the current output of running blead's version of pod/perlrun.pod through pod2html;

current html perlrun

  • the branch output of running the pull request's version of pod/perlrun.pod through pod2html;

branch html perlrun

Assuming that I have properly generated the .man and .html files underlying the .png images, I have a slight preference for the pull request versions over the current versions in blead. This preference is based on typographic readability. I don't believe we have any documentation rules that are strict enough to require one formatting over the other. I'm going to cast a vote in favor of this pull request (which, since it does not change working code, is still eligible for merging in the next 9 days). But I recognize there may be difference of opinion here.

Discuss.

@book book self-requested a review April 11, 2025 23:22
Copy link
Contributor

@book book left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I took me a while to actually see the differences in the screenshots attached by @jkeenan, but once I did, I couldn't unsee them. And I like the new version better.

@jkeenan
Copy link
Contributor

jkeenan commented Apr 12, 2025

I took me a while to actually see the differences in the screenshots attached by @jkeenan, but once I did, I couldn't unsee them. And I like the new version better.

Thanks. I will self-assign this ticket and merge it into blead in about 4 days unless we hear some serious objection.

@jkeenan jkeenan self-assigned this Apr 12, 2025
@jkeenan jkeenan merged commit b8e2ff4 into Perl:blead Apr 16, 2025
34 checks passed
@t-a-k t-a-k deleted the perlrun-use-module branch April 17, 2025 15:48
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants