Skip site navigation (1)Skip section navigation (2)
Date:      Thu, 25 Jan 2001 08:56:30 +1030
From:      Greg Lehey <grog@lemis.com>
To:        Nik Clayton <nik@freebsd.org>
Cc:        Ben Smithurst <csxbcs@comp.leeds.ac.uk>, Alexey Zelkin <phantom@ark.cris.net>, Ruslan Ermilov <ru@FreeBSD.org>, Sheldon Hearn <sheldonh@FreeBSD.org>, Mike Pritchard <mpp@FreeBSD.org>, doc@FreeBSD.org
Subject:   Re: mdoc(7) questionnaire (was: Re: trailing dot in .Nd)
Message-ID:  <20010125085630.F37060@wantadilla.lemis.com>
In-Reply-To: <20010123224241.A1974@canyon.nothing-going-on.org>; from nik@freebsd.org on Tue, Jan 23, 2001 at 10:42:41PM %2B0000
References:  <20010122175432.A31943@sunbay.com> <20010122185304.B25101@comp.leeds.ac.uk> <20010123101530.A98532@sunbay.com> <20010123164227.A4978@ark.cris.net> <20010123162819.C29189@comp.leeds.ac.uk> <20010123224241.A1974@canyon.nothing-going-on.org>

next in thread | previous in thread | raw e-mail | index | archive | help
On Tuesday, 23 January 2001 at 22:42:41 +0000, Nik Clayton wrote:
> I've explicitly pulled Greg Lehey in to this.
>
> On Tue, Jan 23, 2001 at 04:28:19PM +0000, Ben Smithurst wrote:
>> Alexey Zelkin wrote:
>>
>>>> 2.  Should we consistently change all occurrences of ``.Nm Foo'' to
>>>>     ``.Nm foo'' where the command name is actually ``foo''?  (YES, NO)
>>>
>>> Yes, of course, but it just should be changed to construction like
>>>
>>> The command/utility/etc
>>> .Nm
>>
>> I disagree with this, putting "the ... command" around something is just
>> unnecessary IMO.  But perhaps grammatical correctness means more to some
>> people than it does to me. :-)

This is punctuation, not grammar.

> FWIW, that's my opinion as well.  However, out of the depths of my
> somewhat rusty memory I think I recall Greg Lehey having some compelling
> reasons for doing the opposite (i.e., what Alexey is suggesting).  I
> can't for the life of me remember what they were though, hence the cc:,
> in the hope that Greg can remind us.

Hmm.  I can't recall a compelling reason.  Obviously a sentence
starting with a lower-case letter looks funny, so if we can avoid it,
we should.  I've just checked vinum(8), and I find a number of
sequences like this:

  Exit the
  .Nm
  program when running in interactive mode.

  Terminate access to the objects, or stop
  .Nm
  if no parameters are specified.

On the other hand, I also have:

  .Sh DESCRIPTION
  .Nm
  is a utility program to communicate with the \fBVinum\fP\| logical volume
  manager.

This rather confirms my recollection that I'd like to avoid putting
lower-case letters at the beginning of a sentence, but that I'd do it
rather than bloat the style.  I think that's what you're saying as
well. 

Greg
--
Finger grog@lemis.com for PGP public key
See complete headers for address and phone numbers


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




Want to link to this message? Use this URL: <https://mail-archive.FreeBSD.org/cgi/mid.cgi?20010125085630.F37060>