all messages for Emacs-related lists mirrored at yhetil.org
 help / color / mirror / code / Atom feed
From: Eli Zaretskii <eliz@gnu.org>
To: Drew Adams <drew.adams@oracle.com>
Cc: 19682@debbugs.gnu.org
Subject: bug#19682: 25.0.50; `other-window' doc string should say that by default it selects win	in same frame
Date: Mon, 26 Jan 2015 08:30:18 +0200	[thread overview]
Message-ID: <837fwaqcjp.fsf@gnu.org> (raw)
In-Reply-To: <1c4fcb28-17c3-48a6-81c2-c21376e5ac11@default>

> Date: Sun, 25 Jan 2015 15:40:08 -0800 (PST)
> From: Drew Adams <drew.adams@oracle.com>
> Cc: 19682@debbugs.gnu.org
> 
> > I don't see why this single details matters more than the others.
> 
> That is apparently, the problem here - you don't see it.
> 
> The answer to "Why?" is that this information is very useful and
> yet not obvious.

It's not obvious, I agree.  But I don't think it's very useful, except
in very specific and IMO quite rare situations.

> A user looking for a command that cycles among all windows in
> the same frame will not necessarily understand, immediately upon
> reading `C-h f other-window', that that is what this command does.

If she doesn't care, she doesn't need to understand.  If she does,
there are enough hints in the doc string to suggest that reading the
doc string of next-window will explain those details.

> After trying to understand all of that, our poor reader finally
> gets to a reference to function `next-window' and its possible
> arguments.

Nothing wrong with that.  And possibly, an inquisitive enough reader
will discover that even earlier, perhaps much earlier.





  reply	other threads:[~2015-01-26  6:30 UTC|newest]

Thread overview: 9+ messages / expand[flat|nested]  mbox.gz  Atom feed  top
     [not found] <<b0accd37-8912-4873-ad3c-2816b55cdaaa@default>
     [not found] ` <<83iofur7aj.fsf@gnu.org>
2015-01-25 23:40   ` bug#19682: 25.0.50; `other-window' doc string should say that by default it selects win in same frame Drew Adams
2015-01-26  6:30     ` Eli Zaretskii [this message]
     [not found] <<c78c5328-c0eb-4b91-afa1-2dbae2d03280@default>
     [not found] ` <<83ppa2rbta.fsf@gnu.org>
2015-01-25 19:05   ` Drew Adams
2015-01-25 19:26     ` Eli Zaretskii
     [not found] <<733fcda9-19ad-4096-aa8a-7f0f47062ac2@default>
     [not found] ` <<83y4oqrgkv.fsf@gnu.org>
2015-01-25 17:12   ` Drew Adams
2015-01-25 17:48     ` Eli Zaretskii
2016-04-30 16:44       ` Lars Ingebrigtsen
2015-01-25  3:33 Drew Adams
2015-01-25 16:05 ` Eli Zaretskii

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

* Reply using the --to, --cc, and --in-reply-to
  switches of git-send-email(1):

  git send-email \
    --in-reply-to=837fwaqcjp.fsf@gnu.org \
    --to=eliz@gnu.org \
    --cc=19682@debbugs.gnu.org \
    --cc=drew.adams@oracle.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 external index

	https://git.savannah.gnu.org/cgit/emacs.git
	https://git.savannah.gnu.org/cgit/emacs/org-mode.git

This is an external index of several public inboxes,
see mirroring instructions on how to clone and mirror
all data and code used by this external index.