[Date Prev][Date Next][Thread Prev][Thread Next][Date Index][Thread Index]
bug#35063: 26.1; Doc of window parameter `other-window'...
From: |
Eli Zaretskii |
Subject: |
bug#35063: 26.1; Doc of window parameter `other-window'... |
Date: |
Sat, 06 Apr 2019 11:09:13 +0300 |
> Date: Sun, 31 Mar 2019 15:37:18 -0700 (PDT)
> From: Drew Adams <drew.adams@oracle.com>
>
> (elisp) `Window Parameters' should be the place where the window
> parameters are each described.
>
> A reader should not just fall upon a cop-out description such as this:
>
> `other-window'
> This parameter affects the execution of `other-window' (see Cylic
> Window Ordering)
There's nothing wrong, per se, with having the detailed description of
the parameter in a more appropriate place. It isn't a "cop-out".
> But the real bug is that when you go to node Cyclic Window Ordering you
> find nothing at all describing parameter `other-window', whose doc sent
> you there for a real description.
I added the description of other-window parameter there.
> Also, the first sentence of node `Window Parameters' says:
>
> This section describes how window parameters can be used to
> associate additional information with windows.
>
> But it doesn't seem to be mostly about that. Only the description of
> function `set-window-parameter' tells you "how window parameters can be
> used to associate additional information with windows".
I modified that sentence to not imply the actual description of the
parameters must be in this section.
> What's more, the node doesn't really tell you _why_ you would
> associate... What's that for? When would you do that? Not clear from
> this node, AFAICT. OK, a few of the parameter descriptions,
> e.g. `window-preserved-size' give an idea of what they might be used
> for. But most do not, do they?
If you read the detailed descriptions of the parameters in the context
of the functions they affect, I think this question answers itself.
Thanks.
[Prev in Thread] |
Current Thread |
[Next in Thread] |
- bug#35063: 26.1; Doc of window parameter `other-window'...,
Eli Zaretskii <=