Rick:

I made some minor corrections to the manpages (like adding
"attributes" to the SEE ALSO section and using "&cmd;" rather
than using the name of the interface in various paragraphs,
and using "D-Bus" rather than "DBus".  However, would be good
to address the following which I didn't correct:

libotr.3:

I think it would be nice to add a bit more information to the 
DESCRIPTION section than just repeating the SYNOPSIS.  Perhaps
you could explain what "Off-The-Record" means.

The SEE ALSO section should refer to any API documentation.  If
any is installed to the system (e.g. in /usr/share/gtk-doc),
then that should be mentioned.  If there are online docs, then
those should be referenced.  You can refer to the existing
section.3 manpages for examples of how to document this.

I added pidgin to the SEE ALSO section.  Would it be good to
add the libpurple manpages here also?

libpurple.3 & libpurple-client.3:

The DESCRIPTION sections could be a bit more verbose, especially
for libpurple.3 where it matches the SYNOPSIS.

Likewise would be good to refer to any API documentation here.

Brian




Reply via email to