improve description in manpage

Bug #267740 reported by Georg Neis on 2008-09-08
2
Affects Status Importance Assigned to Milestone
chm2pdf (Ubuntu)
Low
Unassigned

Bug Description

Binary package hint: chm2pdf

DESCRIPTION
       chm2pdf is a package supports batch conversion, command line, PDF
       security options, password protection and compression modes. The
       program has Explorer-like interface

Doesn't make a good reading.

ProblemType: Bug
Architecture: amd64
Date: Mon Sep 8 14:23:38 2008
DistroRelease: Ubuntu 8.04
NonfreeKernelModules: nvidia
Package: chm2pdf 0.9-0ubuntu1
PackageArchitecture: all
ProcEnviron:
 LC_CTYPE=en_US.UTF-8
 PATH=/home/username/bin:/usr/local/sbin:/usr/local/bin:/usr/sbin:/usr/bin:/sbin:/bin:/usr/games:/usr/X11R6/bin
 SHELL=/bin/zsh
SourcePackage: chm2pdf
Uname: Linux 2.6.24-19-generic x86_64

Related branches

Georg Neis (gn) wrote :

Do you have a suugestion for improving the manpage? If so, I would
consider it. Otherwise this bug will be marked invalid.

Sent from my iPhone

On Sep 8, 2008, at 8:27 AM, Georg Neis <email address hidden> wrote:

>
> ** Attachment added: "Dependencies.txt"
> http://launchpadlibrarian.net/17373681/Dependencies.txt
>
> --
> improve description in manpage
> https://bugs.launchpad.net/bugs/267740
> You received this bug notification because you are subscribed to
> chm2pdf
> in ubuntu.

Georg Neis (gn) wrote :

The obvious things are the missing "that", the missing "an", and the
missing fullstop. But then there's more space for improvement. The
description doesn't mention at all the program's purpose. I would
start with "chm2pdf converts CHM documents to PDF." Then you can say
what special features it has (password protection of the generated PDF
file, etc.). And maybe say what batch conversion means, I really
don't know (is it just the fact that you can call it with more than
one filename?). And I also have no clue what that Explorer-like
interface is or how to enable it. The manpage doesn't mention it
anywhere else.

Also, there are many markup errors (look for single quotes) and even
the single line description is missing a word.

Launchpad Janitor (janitor) wrote :

This bug was fixed in the package chm2pdf - 0.9.1-0ubuntu2

---------------
chm2pdf (0.9.1-0ubuntu2) intrepid; urgency=low

  * Minor manpage fixes (LP: #267740)

 -- Steve Stalcup <email address hidden> Mon, 08 Sep 2008 21:18:38 -0400

Changed in chm2pdf:
status: New → Fix Released
Steve Stalcup (vorian) on 2008-09-09
Changed in chm2pdf:
importance: Undecided → Low
Georg Neis (gn) wrote :

Now you've changed the description from

  chm2pdf is a package supports batch conversion, command line,
  PDF security options, password protection and compression modes. The program
  has Explorer-like interface

to

  chm2pdf is a package supports batch conversion, command line,
  PDF security options, password protection and compression modes.

Why do you ignore almost all of what I said in my previous mail?

To post a comment you must log in.
This report contains Public information  Edit
Everyone can see this information.

Other bug subscribers