From: Juanma Barranquero <lektu@terra.es>
Cc: monnier+gnu/emacs@rum.cs.yale.edu, emacs-devel@gnu.org
Subject: Re: mentioning variable aliases in `describe-variable'
Date: Fri, 12 Jul 2002 12:17:48 +0200 [thread overview]
Message-ID: <20020712121334.2E82.LEKTU@terra.es> (raw)
In-Reply-To: <E17SoJv-0001fs-00@bundalo.shootybangbang.com>
On Fri, 12 Jul 2002 01:30:03 +0100, John Paul Wallington <jpw@shootybangbang.com> wrote:
> I like your suggestion. How about this:
I like it near the top, too. Much cleaner, IMHO. Also it would make
sense to show the documentation for the aliased variable when describing
the alias. Now, for example:
> automatic-hscrolling's value is t
>
> Documentation:
> Not documented as a variable.
>
> This variable is an alias for `auto-hscroll-mode'.
>
> Defined in `frame'.
but
> auto-hscroll-mode's value is t
>
> Documentation:
> *Allow or disallow automatic scrolling windows horizontally.
> If non-nil, windows are automatically scrolled horizontally to make
> point visible.
>
> You can customize this variable.
>
> Defined in `frame'.
It's not very helpful to mention the aliased variable in the alias
description without the documentation, because that forces the user to
do another describe-variable. And `defvaralias' does not allow
introducing any new documentation for the alias, so there's no
posibility of conflict.
/L/e/k/t/u
next prev parent reply other threads:[~2002-07-12 10:17 UTC|newest]
Thread overview: 26+ messages / expand[flat|nested] mbox.gz Atom feed top
2002-07-10 9:42 mentioning variable aliases in `describe-variable' John Paul Wallington
2002-07-11 19:25 ` Stefan Monnier
2002-07-12 0:30 ` John Paul Wallington
2002-07-12 10:17 ` Juanma Barranquero [this message]
2002-07-12 15:25 ` Stefan Monnier
2002-07-15 15:40 ` Juanma Barranquero
2002-07-16 11:31 ` Juanma Barranquero
2002-07-17 3:04 ` Richard Stallman
2002-07-17 8:02 ` Juanma Barranquero
2002-07-17 13:06 ` arglist in docstring (was: mentioning variable aliases in `describe-variable' ) Stefan Monnier
2002-07-17 13:51 ` Juanma Barranquero
2002-07-17 14:33 ` Stefan Monnier
2002-07-17 15:02 ` Juanma Barranquero
2002-07-17 14:21 ` Juanma Barranquero
2002-07-17 14:31 ` Stefan Monnier
2002-07-17 15:15 ` Juanma Barranquero
2002-07-18 14:55 ` Richard Stallman
2002-07-18 15:25 ` Juanma Barranquero
2002-07-18 21:14 ` Richard Stallman
2002-07-19 6:28 ` Juanma Barranquero
2002-07-12 7:18 ` mentioning variable aliases in `describe-variable' Juanma Barranquero
2002-07-12 7:55 ` John Paul Wallington
2002-07-12 8:00 ` Miles Bader
2002-07-12 8:47 ` John Paul Wallington
2002-07-12 10:26 ` Juanma Barranquero
2002-07-12 15:25 ` Stefan Monnier
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=20020712121334.2E82.LEKTU@terra.es \
--to=lektu@terra.es \
--cc=emacs-devel@gnu.org \
--cc=monnier+gnu/emacs@rum.cs.yale.edu \
/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).