unofficial mirror of emacs-devel@gnu.org 
 help / color / mirror / code / Atom feed
From: "Richard M. Stallman" <rms@gnu.org>
Cc: emacs-devel@gnu.org
Subject: Re: [PATCH] intro.texi
Date: Fri, 02 Sep 2005 02:05:49 -0400	[thread overview]
Message-ID: <E1EB4gP-0004OX-Iq@fencepost.gnu.org> (raw)
In-Reply-To: <92a5eb4705090107224b61e495@mail.gmail.com> (message from Joshua Varner on Thu, 1 Sep 2005 09:22:25 -0500)

Many of your suggested changes are good; I will comment on the ones
that I don't plan to use.

    ! In Lisp, the symbol @dfn{@code{nil}} has three separate meanings: it
    is a symbol with the name @samp{nil}; it is the logical truth value

We don't write @dfn around @code.

    @cindex documentation notation
    + @cindex notation, evaluation
    + @cindex notation, documentation

Having two index entries in the same place that start with the same
word is redundant; it would be better to add

    @cindex notation

    Examples in this manual indicate printed text with @samp{@print{}},
    irrespective of where that text goes. The value returned by
    ! evaluating the form (here @code{bar}) follows on a separate line with
    ! @samp{@result{}}.

    @example
    @group
    --- 264,271 ----

    Examples in this manual indicate printed text with @samp{@print{}},
    irrespective of where that text goes. The value returned by
    ! evaluating the form (in the example below: @code{bar}) follows on a
    ! separate line with @samp{@result{}}.

Using "here" is conventional, so it is good enough.

    @defvar emacs-major-version
    The major version number of Emacs, as an integer. For Emacs version
    ! 20.3, the value is @code{20}.

We don't write @code around values that are numbers.
It looks better not to do so.

      reply	other threads:[~2005-09-02  6:05 UTC|newest]

Thread overview: 2+ messages / expand[flat|nested]  mbox.gz  Atom feed  top
2005-09-01 14:22 [PATCH] intro.texi Joshua Varner
2005-09-02  6:05 ` Richard M. Stallman [this message]

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=E1EB4gP-0004OX-Iq@fencepost.gnu.org \
    --to=rms@gnu.org \
    --cc=emacs-devel@gnu.org \
    /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).