develooper Front page | perl.perl5.porters | Postings from January 2011

[perl #81588] Carp man-page broken

From:
Mark Overmeer
Date:
January 3, 2011 14:17
Subject:
[perl #81588] Carp man-page broken
Message ID:
rt-3.6.HEAD-5425-1294043563-1891.81588-75-0@perl.org
# New Ticket Created by  Mark Overmeer 
# Please include the string:  [perl #81588]
# in the subject line of all future correspondence about this issue. 
# <URL: http://rt.perl.org/rt3/Ticket/Display.html?id=81588 >



As can be seen in the list of http://search.cpan.org/~jesse/perl-5.12.2/
the Carp man-page is non-conforming.  The problem is caused by its
"NAME" head1, which is mal-formed.

The current start:

  =head1 NAME

  carp    - warn of errors (from perspective of caller)

  cluck   - warn of errors with stack backtrace
            (not exported by default)

  croak   - die of errors (from perspective of caller)

  confess - die of errors with stack backtrace

  =head1 SYNOPSIS

    use Carp;
    croak "We're outta here!";

    use Carp qw(cluck);
    cluck "This is how we got here!";

could be rewritten as

  =head1 NAME

  Carp - alternative die and warn for modules

  =head1 SYNOPSIS

    use Carp;

    # warn user (from perspective of caller)
    carp "string trimmed to 80 chars";

    # die of errors (from perspective of caller)
    croak "We're outta here!";

    # die of errors with stack backtrace
    confess "not implemented";

    # cluck not exported by default
    use Carp qw(cluck);
    cluck "This is how we got here!";

-- 
Regards,
               MarkOv

------------------------------------------------------------------------
       Mark Overmeer MSc                                MARKOV Solutions
       Mark@Overmeer.net                          solutions@overmeer.net
http://Mark.Overmeer.net                   http://solutions.overmeer.net




nntp.perl.org: Perl Programming lists via nntp and http.
Comments to Ask Bjørn Hansen at ask@perl.org | Group listing | About