all messages for Emacs-related lists mirrored at yhetil.org
 help / color / mirror / code / Atom feed
From: Drew Adams <drew.adams@oracle.com>
To: Eli Zaretskii <eliz@gnu.org>, Drew Adams <drew.adams@oracle.com>
Cc: 21305-done@debbugs.gnu.org
Subject: bug#21305: 25.0.50; `get-buffer-window-list' doc - what order?
Date: Fri, 21 Aug 2015 08:28:18 -0700 (PDT)	[thread overview]
Message-ID: <b7c7a7fe-1e8a-4add-8585-1698e16348cf@default> (raw)
In-Reply-To: <<83mvxkis5t.fsf@gnu.org>>

> > But I think it would be helpful to tell users that the order is
> > the same as that described in `Cyclic Window Ordering'.
> 
> What can the users do with that information?  (It is already in the
> ELisp manual; I'm talking about the doc string here.)

In the manual?  Where?  I don't see it, so far (in the build I have
from 7/31.  I do see that the manual says this, but this speaks only
to the meaning of these two arguments - it says nothing about the
order of the windows in the returned value.

  The arguments MINIBUF and ALL-FRAMES have the same meanings as in
                ^^^^^^^^^^^^^^^^^^^^^^
  the function 'next-window' (*note Cyclic Window Ordering::).  Note
  that the ALL-FRAMES argument does _not_ behave exactly like in
  'get-buffer-window'. 

> > > Describing the order would require a non-trivial amount of text,
> > > so without a good reason, I don't think we should add it.
> >
> > How is it more difficult than saying that the order is the same as
> > that specified in `Cyclic Window Ordering', and xreffing that
> > node?
> 
> I consider references to the manual in doc strings a bad habit.

I meant in the manual.  There is an xref to that node, but it is
given only for info about arguments MINIBUF and ALL-FRAMES.  It would
be helpful, I think, to explicitly say that the order of the windows
in the return value (a) starts with the selected window (which you
have added) and (b) follows the order cyclic window ordering.





       reply	other threads:[~2015-08-21 15:28 UTC|newest]

Thread overview: 24+ messages / expand[flat|nested]  mbox.gz  Atom feed  top
     [not found] <<870b6a90-e498-4ed9-9e41-d498edf33aec@default>
     [not found] ` <<83mvxkis5t.fsf@gnu.org>
2015-08-21 15:28   ` Drew Adams [this message]
2015-08-21 18:28     ` bug#21305: 25.0.50; `get-buffer-window-list' doc - what order? Eli Zaretskii
     [not found]   ` <<b7c7a7fe-1e8a-4add-8585-1698e16348cf@default>
     [not found]     ` <<83lhd4ijh3.fsf@gnu.org>
2015-08-21 19:18       ` Drew Adams
     [not found] <<5430f5a7-2939-4f96-8c6c-3e820ffcfd6b@default>
     [not found] ` <<83oai0iwbc.fsf@gnu.org>
2015-08-21 15:08   ` Drew Adams
2015-08-21 15:21     ` Eli Zaretskii
     [not found] ` <<55D74386.6010708@gmx.at>
     [not found]   ` <<7036da11-d296-45a9-b6ee-d7b68830927e@default>
     [not found]     ` <<55D74AA3.1070202@gmx.at>
     [not found]       ` <<1b17a036-c525-4dbc-84fa-cc8adc2b6488@default>
     [not found]         ` <<50fbb71c-8a6d-45b4-a467-a31bcc73ac09@default>
     [not found]           ` <<a18faa5f-a31e-49c2-809b-64fdd40fa273@default>
     [not found]             ` <<55D8195A.4040804@gmx.at>
     [not found]               ` <<9aa1dcd7-1781-41aa-bf47-7b280b26da1e@default>
     [not found]                 ` <<jwvoahziaao.fsf-monnier+emacsbugs@gnu.org>
     [not found]                   ` <<cf171405-a9e3-4312-b456-ff68352d4052@default>
     [not found]                     ` <<83a8tji626.fsf@gnu.org>
2015-08-22 19:01                       ` Drew Adams
2015-08-23 22:34                         ` Stefan Monnier
     [not found] <<089f48ed-6ce9-4753-abcf-3f86d43a278e@default>
     [not found] ` <<83vbc8iyut.fsf@gnu.org>
2015-08-21 13:21   ` Drew Adams
2015-08-21 13:51     ` Eli Zaretskii
2015-08-21 15:28     ` martin rudalics
2015-08-21 15:30       ` Drew Adams
2015-08-21 15:58         ` martin rudalics
2015-08-20 17:49           ` Drew Adams
2015-08-21 12:56             ` Eli Zaretskii
2015-08-21 16:12             ` Drew Adams
2015-08-21 16:32               ` Drew Adams
2015-08-21 17:42                 ` Drew Adams
2015-08-22  6:40                   ` martin rudalics
2015-08-22 14:31                     ` Drew Adams
2015-08-22 16:01                       ` Stefan Monnier
2015-08-22 17:23                         ` Drew Adams
2015-08-22 17:30                           ` Eli Zaretskii
2015-08-23 13:33                         ` martin rudalics
2015-08-21 16:00           ` Drew Adams

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=b7c7a7fe-1e8a-4add-8585-1698e16348cf@default \
    --to=drew.adams@oracle.com \
    --cc=21305-done@debbugs.gnu.org \
    --cc=eliz@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 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.