unofficial mirror of emacs-devel@gnu.org 
 help / color / mirror / code / Atom feed
From: Xue Fuqiao <xfq.free@gmail.com>
To: Rand User <rand.user@ymail.com>
Cc: "emacs-devel@gnu.org" <emacs-devel@gnu.org>
Subject: Re: split-window as a command
Date: Sat, 13 Apr 2013 14:29:26 +0800	[thread overview]
Message-ID: <20130413142926.0c1ae18acd0dc27e1eeaa9e2@gmail.com> (raw)
In-Reply-To: <1365831945.71816.YahooMailNeo@web141206.mail.bf1.yahoo.com>

[-- Attachment #1: Type: text/plain, Size: 1795 bytes --]

On Fri, 12 Apr 2013 22:45:45 -0700 (PDT)
Rand User <rand.user@ymail.com> wrote:

> >>  > This command is obsolete since 24.4; use `C-x 2' instead

> I think explicitly giving the name of the obsolete command
> 
> and the replacement command would be better. Something similar
> to the format used by `define-obsolete-function-alias'
> 
>     `split-window' is an obsolete command (as of 24.4); use `split-window-below' instead
> 
> 
> or maybe
> 
>     The command `split-window' is obsolete (as of 24.4); use `split-window-below' instead
> 

In (info "(elisp) Documentation Tips"):

  Format the documentation string so that it fits in an Emacs window on
  an 80-column screen.  It is a good idea for most lines to be no wider
  than 60 characters.  The first line should not be wider than 67
  characters or it will look bad in the output of `apropos'.

Although I don't find a convention on echo area, I think it is good to
follow this convention.  See the attached files.

> >> Also, `C-x 2' looks more like a key sequence than a command name.
> >
> > Yes.  There are 2 reasons to use `C-x 2' here:
> >
> > 1. It is usually too long to display two command names in the echo area;
> > (I even want to drop the " since 24.4".)
> >
> > 2. It is more convenient for users to execute the command, since they
> 
> Encountering obsolete commands should be pretty rare,
> 
> so I think a detailed message is more important than
> the convenience aspect.

The detailed message can be in the output of `describe-function' and
`describe-key', the message in echo area shouldn't be too long.

> Perhaps something like `disable-command' could be used
> instead of just a message.

Sounds fine to me.

-- 
Xue Fuqiao
http://www.gnu.org/software/emacs/

[-- Attachment #2: screenshot.png --]
[-- Type: image/png, Size: 4285 bytes --]

[-- Attachment #3: screenshot2.png --]
[-- Type: image/png, Size: 4609 bytes --]

  reply	other threads:[~2013-04-13  6:29 UTC|newest]

Thread overview: 16+ messages / expand[flat|nested]  mbox.gz  Atom feed  top
2013-04-12  7:58 split-window as a command Stephen Berman
2013-04-12  9:29 ` martin rudalics
2013-04-12 11:37   ` Stephen Berman
2013-04-12 14:13     ` martin rudalics
2013-04-12 19:44       ` Rand
2013-04-12 23:05         ` Xue Fuqiao
2013-04-12 23:31         ` Stephen Berman
2013-04-13  0:52           ` Xue Fuqiao
2013-04-13  1:54             ` Rand User
2013-04-13  2:46               ` Xue Fuqiao
2013-04-13  5:45                 ` Rand User
2013-04-13  6:29                   ` Xue Fuqiao [this message]
2013-04-13  1:44           ` Rand User
2013-04-13  8:03             ` martin rudalics
2013-04-13  2:10         ` Stefan Monnier
2013-04-13 14:45           ` Stephen Berman

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=20130413142926.0c1ae18acd0dc27e1eeaa9e2@gmail.com \
    --to=xfq.free@gmail.com \
    --cc=emacs-devel@gnu.org \
    --cc=rand.user@ymail.com \
    /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).