Skip site navigation (1)Skip section navigation (2)
Date:      Mon, 29 Jun 1998 10:57:29 +0100 (BST)
From:      Doug Rabson <dfr@nlsystems.com>
To:        Dag-Erling Coidan Smrgrav <smoergrd@oslo.geco-prakla.slb.com>
Cc:        Thomas Dean <tomdean@ix.netcom.com>, current@FreeBSD.ORG
Subject:   Re: Draft manpages available for review
Message-ID:  <Pine.BSF.3.95q.980629105632.1385L-100000@herring.nlsystems.com>
In-Reply-To: <rx4iulko7yz.fsf@oslo.geco-prakla.slb.com>

next in thread | previous in thread | raw e-mail | index | archive | help
On 29 Jun 1998, Dag-Erling Coidan Smrgrav wrote:

> Doug Rabson <dfr@nlsystems.com> writes:
> > > Some man pages do not have 'Return Values' sections.
> > > [...]
> > I didn't bother with a 'Return Values' section for functions which were
> > void or where the return value was described in the 'Description' section.
> 
> Bzzzt, if you basically know what the function does but are unsure
> about the return values, having a separate RETURN VALUES section is
> very useful since it makes finding this information much quicker.

Most of these functions are just accessors.  They don't actually *do*
anything, just return stuff.  Maybe I should just rename the 'DESCRIPTION'
section to 'RETURN VALUES'.

--
Doug Rabson				Mail:  dfr@nlsystems.com
Nonlinear Systems Ltd.			Phone: +44 181 951 1891
					Fax:   +44 181 381 1039


To Unsubscribe: send mail to majordomo@FreeBSD.org
with "unsubscribe freebsd-current" in the body of the message



Want to link to this message? Use this URL: <https://mail-archive.FreeBSD.org/cgi/mid.cgi?Pine.BSF.3.95q.980629105632.1385L-100000>