Re: doc-strings: T vs t

[Pavel Janík]

   From: address@hidden (Gerd Moellmann)
   Date: 29 Oct 2001 09:43:45 +0100

   > > Generally: how should we wrote the t, nil or functions names in the
   > > doc-strings at the beginning of sentences?
   > 
   > I've always just avoided that case by reformulating the doc.  Does
   > lispref/tips.texi say anything about this?  Maybe it should if it
   > doesn't.

There is something about writing t and similar, but the case when it is at
the beginning of sentence is not clearly stated.

What about this change:

--- tips.texi.~1.37.~   Tue Jul 10 12:51:30 2001
+++ tips.texi   Mon Oct 29 11:39:14 2001
@@ -597,9 +597,10 @@
 @item
 @iftex
 When a documentation string refers to a Lisp symbol, write it as it
-would be printed (which usually means in lower case), with single-quotes
-around it.  For example: @samp{`lambda'}.  There are two exceptions:
-write @code{t} and @code{nil} without single-quotes.
+would be printed (which usually means in lower case, even at the
+beginning of sentences), with single-quotes around it.  For
+example: @samp{`lambda'}.  There are two exceptions: write @code{t}
+and @code{nil} without single-quotes.
 @end iftex
 @ifnottex
 When a documentation string refers to a Lisp symbol, write it as it

-- 
Pavel Janík

Sounds like a "bug waiting to be implemented" ;)
                  -- Rik van Riel in linux-kernel