Bug#681417: Please reconsider package description

Martin Eberhard Schauer Martin.E.Schauer at gmx.de
Thu Jul 12 23:32:55 UTC 2012


Package: libswt-gtk-3-java
Version: 3.7-2+b1
Severity: wishlist
X-Debbugs-CC: debian-l10n-english at lists.debian.org


Dear Java Maintainers,

thank you for maintaining src:swt-gtk. I'm sorry to say that IMHO at 
least one
package description(s) is(are) problematic. An example: 
libswt-gtk-3-java (1).
Its boilerplate in the first paragraph is reused in six other descriptions.


    Description: Standard Widget Toolkit for GTK+ Java library

Having a look at the short description itself one could misunderstand it as
too much capitalisation. Actually it does not obey the Developer's Reference
recommendations (2): It repeats the package name. And though its upstream's
fault (3) the package name itself is too generic. It makes sense to 
translate
it.

     The Standard Widget Toolkit (SWT) is a fast and rich GUI toolkit 
for the
     Java programming language. SWT provides efficient, portable and fast
     access to native controls and user interface facilities on the 
platforms
     where it has been implemented.

It's very much appreciated that you did *not* copy the upstream description
verbatim. "For" sounds like geek speech to me. Perhaps I have a German point
of view at the description.

     This package includes the SWT JAR libraries.

Are you sure that Jon Doe knows what a JAR (4) is? (Sorry for citing a 
German
source.)

I would be glad if you like my suggestion:


    Description: Java widget toolkit for GTK+
     The Standard Widget Toolkit (SWT) is a fast and rich Java GUI toolkit.
     For platforms with existing SWT implementations it provides efficient,
     portable and fast access to native controls and user interface 
facilities.
     .
     This package includes the SWT Java archive (jar) libraries.

Kind regards,
     Martin


1: http://ddtp.debian.net/ddt.cgi?desc_id=67727
2: 
http://www.debian.org/doc/manuals/developers-reference/best-pkging-practices.html#bpp-pkg-synopsis
3: http://www.eclipse.org/swt/
4: http://de.wikipedia.org/wiki/Java_Archive





More information about the pkg-java-maintainers mailing list