unofficial mirror of bug-gnu-emacs@gnu.org 
 help / color / mirror / code / Atom feed
From: Drew Adams <drew.adams@oracle.com>
To: 21225@debbugs.gnu.org
Subject: bug#21225: 25.0.50; doc strings of `define-obsolete-*'
Date: Sun, 9 Aug 2015 10:35:09 -0700 (PDT)	[thread overview]
Message-ID: <7c3e32cc-1fec-4675-b330-5affa4452e95@default> (raw)
In-Reply-To: <7ec85eda-d5e0-4bda-8dba-4a75fe5f93e5@default>

I forgot to add:

The doc (doc strings and manual) should make clear that the args
are evaluated.  This is not obvious, as these are macros.

For example, this is needed:

(define-obsolete-variable-alias 'last-input-char 'last-input-event
  "at least 19.34")

This is no good:

(define-obsolete-variable-alias last-input-char last-input-event
  "at least 19.34")

The current doc is quite unclear about this, especially by just
referring to the args as "*-NAME".  (Nothing wrong with those
parameter names, as long as you make clear that the args are
evaluated.)





  reply	other threads:[~2015-08-09 17:35 UTC|newest]

Thread overview: 5+ messages / expand[flat|nested]  mbox.gz  Atom feed  top
2015-08-09 17:28 bug#21225: 25.0.50; doc strings of `define-obsolete-*' Drew Adams
2015-08-09 17:35 ` Drew Adams [this message]
2015-08-11 12:50   ` Artur Malabarba
2015-08-11 16:07     ` Stefan Monnier
2016-04-30 21:52 ` Lars Ingebrigtsen

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=7c3e32cc-1fec-4675-b330-5affa4452e95@default \
    --to=drew.adams@oracle.com \
    --cc=21225@debbugs.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).