bug-mailutils
[Top][All Lists]
Advanced

[Date Prev][Date Next][Thread Prev][Thread Next][Date Index][Thread Index]

doc cleanups and questions


From: Sean 'Shaleh' Perry
Subject: doc cleanups and questions
Date: Fri, 29 Dec 2000 19:45:12 -0800 (PST)

In several places the statement -- "The return value is @code{0} on success and
a code number on error conditions" -- is made.  'a code number' just does not
sound right.  error code, something else please.

the sfrom example, status is used to check numerous return values, but in some
cases the value of status is not used:

if ((status = foo()) != 0)

why use status here instead of if (foo() != 0)?

the main info menu bullets need attention.  Several are flagged as 'foo API'
while others just say 'foo', i.e. Attributes.

why does the stream api example show how to make a web browser? (or use a goto
for that matter (-:

attached is a patch to the doc dir.  It cleans up much of the text to
reasonable English.  Alain (I assume it was you) you need to watch your tenses
and numbers.  Most of the patch is making verbs and nouns agree.  Things like 

-The ressources allocate for @var{hdr} are freed.
+The resources allocated for @var{hdr} are freed.

plural noun, verb should agree.

Attachment: mailutils.shaleh.patch
Description: Binary data


reply via email to

[Prev in Thread] Current Thread [Next in Thread]