unofficial mirror of emacs-devel@gnu.org 
 help / color / mirror / code / Atom feed
From: Luc Teirlinck <teirllm@dms.auburn.edu>
Cc: eliz@gnu.org, mh-e-devel@lists.sourceforge.net, emacs-devel@gnu.org
Subject: Re: MH-E manual update
Date: Sat, 11 Mar 2006 17:08:12 -0600 (CST)	[thread overview]
Message-ID: <200603112308.k2BN8CO23003@raven.dms.auburn.edu> (raw)
In-Reply-To: <11886.1142116037@olgas.newt.com> (message from Bill Wohler on Sat, 11 Mar 2006 14:27:17 -0800)

Bill Wohler wrote:

   In (texinfo) code:

	 Thus, you should use `@code' for an expression in a program, for the
       name of a variable or function used in a program, or for a keyword in a
       programming language.

   If we are in agreement, this paragraph should be amended to say "for the
   name *or value* of a variable or function" since it would be
   inconsistent and complicate usage to use @code for string values and
   @samp for other values.

It already says: "you should use `@code' for an expression in a program".
Strings in a program are expressions, be it constant ones.  One writes:
"The standard value of this variable is @code{nil}", not @samp{nil}.

   ...with three exceptions in strings.texi and text.texi. A quick grep in
   the Elisp manual didn't reveal any @samp{.*} (without quotes) that
   looked like they might be a variable's value.

I changed those three to use @code, since they were inconsistent with
the vast majority of similar cases.

   If we are in agreement, can someone who has the Texinfo manual checked
   out make the clarification in the @code section?

Karl Berry maintains that manual, but I am not immediately sure that a
change is called for, for the reasons explained above.

Sincerely,

Luc.

  reply	other threads:[~2006-03-11 23:08 UTC|newest]

Thread overview: 28+ messages / expand[flat|nested]  mbox.gz  Atom feed  top
2005-12-09  0:27 MH-E manual update Bill Wohler
2005-12-09 11:58 ` Eli Zaretskii
2005-12-09 14:40   ` Bill Wohler
2005-12-09 18:50     ` Eli Zaretskii
2005-12-09 21:15   ` Richard M. Stallman
2005-12-10  0:25     ` Bill Wohler
2005-12-10 16:18       ` Richard M. Stallman
2006-03-07  1:29 ` Bill Wohler
2006-03-11 14:30   ` Eli Zaretskii
2006-03-11 20:08     ` Bill Wohler
2006-03-11 21:35       ` Luc Teirlinck
2006-03-11 22:27         ` Bill Wohler
2006-03-11 23:08           ` Luc Teirlinck [this message]
2006-03-11 23:34             ` Bill Wohler
2006-03-11 23:24           ` Luc Teirlinck
2006-03-11 23:40             ` Bill Wohler
2006-03-11 23:39               ` Luc Teirlinck
2006-03-11 23:49                 ` Bill Wohler
2006-03-12  2:39                   ` Luc Teirlinck
2006-03-12  3:56                     ` Bill Wohler
2006-03-12  0:39               ` Luc Teirlinck
2006-03-11 22:10       ` Eli Zaretskii
2006-03-11 23:32         ` Bill Wohler
2006-03-12 11:59           ` Robert J. Chassell
2006-03-13 12:55             ` Richard Stallman
2006-03-13 15:20               ` Robert J. Chassell
2006-03-13 16:29               ` Bill Wohler
2006-03-14  4:26                 ` Eli Zaretskii

Reply instructions:

You may reply publicly to this message via plain-text email
using any one of the following methods:

* Save the following mbox file, import it into your mail client,
  and reply-to-all from there: mbox

  Avoid top-posting and favor interleaved quoting:
  https://en.wikipedia.org/wiki/Posting_style#Interleaved_style

  List information: https://www.gnu.org/software/emacs/

* Reply using the --to, --cc, and --in-reply-to
  switches of git-send-email(1):

  git send-email \
    --in-reply-to=200603112308.k2BN8CO23003@raven.dms.auburn.edu \
    --to=teirllm@dms.auburn.edu \
    --cc=eliz@gnu.org \
    --cc=emacs-devel@gnu.org \
    --cc=mh-e-devel@lists.sourceforge.net \
    /path/to/YOUR_REPLY

  https://kernel.org/pub/software/scm/git/docs/git-send-email.html

* If your mail client supports setting the In-Reply-To header
  via mailto: links, try the mailto: link
Be sure your reply has a Subject: header at the top and a blank line before the message body.
Code repositories for project(s) associated with this public inbox

	https://git.savannah.gnu.org/cgit/emacs.git

This is a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox;
as well as URLs for read-only IMAP folder(s) and NNTP newsgroup(s).