unofficial mirror of emacs-devel@gnu.org 
 help / color / mirror / code / Atom feed
From: Nick Roberts <nickrob@snap.net.nz>
Cc: emacs-devel@gnu.org
Subject: Documentation of obsolete declarations and aliases.
Date: Thu, 5 May 2005 09:05:20 +1200	[thread overview]
Message-ID: <17017.14608.787742.440748@farnswood.snap.net.nz> (raw)
In-Reply-To: <200505040230.j442UFY20511@raven.dms.auburn.edu>

 > I propose the following doc changes.  The main two points are the following.
 > 
 > Firstly, since the Elisp manual describes the details of how to
 > declare variables obsolete, should it not also document how to declare
 > functions obsolete?  The patch to lispref/functions.texi does that
 > with a new node "Obsolete Functions".

I described how to declare variables obsolete in the node 'Defining Variables'
as defvaralias was described there. The node 'Defining Functions' describes
defalias, so that might be a natural place to put your changes. I also
suggested a single node called 'Obsoletion' where both sets of changes could
go.

 >       ...  The documentation also fails to point out that the main
 > arguments to these macros need to be quoted (which is somewhat
 > surprising for macros.)  I believe that it is better to give a usage
 > example with expansion, as the patches below do, and refer to the
 > docstrings of the two functions they combine for details on those two
 > individual functions.

An example seems like a good idea.


Nick

  reply	other threads:[~2005-05-04 21:05 UTC|newest]

Thread overview: 5+ messages / expand[flat|nested]  mbox.gz  Atom feed  top
2005-05-04  2:30 Documentation of obsolete declarations and aliases Luc Teirlinck
2005-05-04 21:05 ` Nick Roberts [this message]
2005-05-05 22:29   ` Luc Teirlinck
2005-05-05 22:38     ` Nick Roberts
2005-05-05 19:45 ` Richard Stallman

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=17017.14608.787742.440748@farnswood.snap.net.nz \
    --to=nickrob@snap.net.nz \
    --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).