Debian Bug report logs - #902873
libprotocol-irc-perl: Automatically extracted, not reviewed and difficult to understand package description

Reply or subscribe to this bug.

Display info messages

Message #5 received at [email protected] (full text, mbox, reply):

From: Axel Beckert <[email protected]>

To: Debian Bug Tracking System <[email protected]>

Subject: libprotocol-irc-perl: Automatically extracted, not reviewed and difficult to understand package description

Date: Mon, 02 Jul 2018 18:33:32 +0200

Package: libprotocol-irc-perl
Version: 0.12-2
Severity: minor

Dear Andrew,

the current package description of libprotocol-irc-perl is:

 This mix-in class provides a base layer of IRC message handling logic. It
 allows reading of IRC messages from a string buffer and dispatching them to
 handler methods on its instance.
 .
 Protocol::IRC::Client provides an extension to this logic that may be more
 convenient for IRC client implementations. Much of the code provided here is
 still useful in client applications, so the reader should be familiar with
 both modules.
 .
 This description was automagically extracted from the module by dh-make-perl.

This has several issues:

a) It obviously has been automatically extracted from some upstream
   documentation and never has been reviewed. Didn't you run lintian
   over your package before uploading? Lintian detects this:

   W: libprotocol-irc-perl: description-contains-dh-make-perl-template

b) Please mention Protocol::IRC in the first paragraph, otherwise it's
   not obvious what "This mix-in" refers to, because a module name very
   similar to the package name is used in the second paragraph of the
   package and I at least had to read the package description three
   times before  I understood which two modules are included and what
   relation they have.

I would have fixed this myself (with my Debian Perl Team hat on :-), but
unfortunately…

c) … the last changes for 0.12-2 haven't been pushed to Salsa yet.

-- System Information:
Debian Release: buster/sid
  APT prefers unstable
  APT policy: (990, 'unstable'), (600, 'testing'), (500, 'unstable-debug'), (500, 'buildd-unstable'), (110, 'experimental'), (1, 'experimental-debug'), (1, 'buildd-experimental')
Architecture: amd64 (x86_64)

Kernel: Linux 4.15.0-2-amd64 (SMP w/8 CPU cores)
Locale: LANG=C.UTF-8, LC_CTYPE=C.UTF-8 (charmap=UTF-8), LANGUAGE=C.UTF-8 (charmap=UTF-8)
Shell: /bin/sh linked to /bin/dash
Init: sysvinit (via /sbin/init)
LSM: AppArmor: enabled

Versions of packages libprotocol-irc-perl depends on:
ii  perl  5.26.2-6

libprotocol-irc-perl recommends no packages.

libprotocol-irc-perl suggests no packages.

-- no debconf information

Send a report that this bug log contains spam.