Have you considered asking on docs-discuss at opensolaris.org for man
page review? That's where the doc experts would be found. (I've
gone ahead and done just that - for their benefit, your original
message is attached so they can see the entire man pages.)
> EXAMPLES
> Example 1: Launching gnome-power-statistics
>
> example% gnome-power-statistics
>
> Example 2: Launching gnome-power-statistics with displaying
> extra debugging messages.
>
> example% gnome-power-statistics --verbose
I'd rather see no examples section than including such obvious and
trivial examples. If you must keep it, then Example 2 should either
be "Launching gnome-power-statistics with the display of extra
debugging messages" or "Launching gnome-power-statistics displaying
extra debugging messages" - "with displaying" is poor grammar.
> NOTES
> This manual page was written by Simon Zheng
> simon.zheng at sun.com for the Debian system.
Don't you mean for OpenSolaris, not Debian?
> DESCRIPTION
> This manual page documents briefly the gnome-power-
> preferences.
That seems like a useless paragraph, of course the man page documents
the program, that's what all man pages do - why not delete it and just
leave the description as:
> gnome-power-preferences is the configuration gui for the
> gnome power management infrastructure.
--
-Alan Coopersmith- alan.coopersmith at sun.com
Sun Microsystems, Inc. - X Window System Engineering
-------------- next part --------------
An embedded message was scrubbed...
From: "simon.zheng at sun.com" <[email protected]>
Subject: [jds-review] Man page for GNOME Power Manager
Date: Thu, 14 Feb 2008 15:44:01 +0800
Size: 13895
URL:
<http://mail.opensolaris.org/pipermail/docs-discuss/attachments/20080214/32960518/attachment.nws>
