user-pic

BooK

Subscribe to feed Recent Actions from BooK

  • JT Smith commented on In “Cede Your Soul”, an episode of a tv show called “Blindspot”...

    Damn it BooK! Why did you have to turn this dirty. =)

  • brian d foy commented on ...but which one is easier to learn?

    Actually, Learning Perl never split. Intermediate Perl was the re-titled Learning Perl: Packages, References, and Modules. That book covered Perl 5 features that Learning Perl, a Perl 4 book, didn't.

  • Steven Bakker commented on POD speculation

    Regarding the nesting level, isn't it possible to just use =head3 for the functions/methods themselves? My pod2html renders that fine (so does perldoc).

  • chris fedde commented on POD speculation

    No one ever reads my doc. Much less the actual pod that generates it. If the topic even comes up it is to defend the use of perl when blub is so much better. Still here are my thoughts:

    I'm pretty much a snippet user and use one that maps sub foo into =head3 foo\n\n\n\=cut\n\nsub foo {\n}

    The main reason to choose a head over a item is the typesetting tradition of TOC elements for all heads. The choice of =head3 leaves room for a =head2 to provide subsections if needed between the predefined =head1 sections demanded by manual page convention. Of course I did spend quite a…

  • Steven Bakker commented on POD speculation

    Hi Chris,

    Makes sense. I always used "=item" because it allowed me to say "=item B<foo> ( [I<arg>] )", but that only gets you so far. It looks nice, but it doesn't show up in the TOC, and worse, for longer lists of methods/functions, I often screw up with the "=over"/"=back" balancing.

    I think I'll switch to "=head3" from now on.

    And in my case, people do read my doc. Unfortunately, people that then take over maintenance make changes, but neglect to update the doc (including updating the AUTHOR entry, so I get blamed for bad documentation).

Subscribe to feed Responses to Comments from BooK

About blogs.perl.org

blogs.perl.org is a common blogging platform for the Perl community. Written in Perl and offering the modern features you’ve come to expect in blog platforms, the site is hosted by Dave Cross and Aaron Crane, with a design donated by Six Apart, Ltd.