[Date Prev][Date Next][Thread Prev][Thread Next][Date Index][Thread Index]

[Omaha.pm] POD



My $0.02 / FYI / ignore me --

In blocks like this

------
=head2 set_request

   gets RequestAvail object

=cut
-------

You don't want to indent "normal text". Leave the indention off and POD
viewers re-wrap paragraphs to fit the width of the viewers screen. When you
indent in POD you're telling the viewer to never line-wrap, which is good
for code samples but bad for normal descriptive text.

And "podchecker" is a handy tool, below.

Thanks,

J



jhannah@razorbill:~/M/omares/Complex> podchecker L_Reservation.pm
*** ERROR: Spurious text after =cut at line 175 in file L_Reservation.pm
*** ERROR: Spurious text after =cut at line 182 in file L_Reservation.pm
*** WARNING: line containing nothing but whitespace in paragraph at line 263
in file L_Reservation.pm
*** ERROR: empty =head2 at line 545 in file L_Reservation.pm
*** WARNING: line containing nothing but whitespace in paragraph at line 827
in file L_Reservation.pm
L_Reservation.pm has 3 pod syntax errors.