Bug#679900: package description copied from manual page

Martin Eberhard Schauer Martin.E.Schauer at gmx.de
Mon Jul 2 10:21:51 UTC 2012


Package: libdevel-stacktrace-perl
Version: 1.2700-1
Severity: wishlist
X-Debbugs-CC: debian-l10n-english at lists.debian.org

Dear Perl Maintainers,
translating the description (1) I wondered whether it is too technical.
Actually the text appears to be copied from the manual page (2).

    Description: Perl module containing stack trace and stack trace 
frame objects
     The Devel::StackTrace module contains two classes, Devel::StackTrace
     and Devel::StackTraceFrame.  The goal of this object is to encapsulate
     the information that can found through using the caller() function, as
     well as providing a simple interface to this data.

I'm not comfortable with the wording here. I'm not a Perl programmer yet 
and I
believe that a module provides code for a class that becomes instantiated in
an object.
     .
     The Devel::StackTrace object contains a set of Devel::StackTraceFrame
     objects, one for each level of the stack.  The frames contain all the
     data available from caller() as of Perl 5.6.0 though this module still
     works with 5.00503.

These are quite old Perl versions. They are not mentioned by upstream 
(2) any
more.

     .
     This code was created to support the Exception::Class::Base class
     (part of Exception::Class) but may be useful in other contexts.

I doubt that this is information suitable for the clueless person 
considering
whether to install this module.

Please consider this shortened version:

    Description: Perl module providing stack trace facilities
     The Devel::StackTrace module provides two classes, Devel::StackTrace
     and Devel::StackTraceFrame.
     .
     The Devel::StackTrace object encapsulates the information that can be
     obtained by using the caller() function, as well as providing a simple
     interface to this data.
     .
     The Devel::StackTrace object contains a set of Devel::StackTraceFrame
     objects, one for each level of the stack.  The frames contain all the
     data available from caller().


Kind regards,
    Martin

1: http://ddtp.debian.net/ddt.cgi?desc_id=61420
1: http://search.cpan.org/dist/Devel-StackTrace/lib/Devel/StackTrace.pm
3: http://www.perlmonks.org/index.pl?node_id=232930
Kind regards
        Martin





More information about the pkg-perl-maintainers mailing list