unofficial mirror of emacs-devel@gnu.org 
 help / color / mirror / code / Atom feed
* put value last in *Help* buffer for C-h v?
@ 2007-03-25 20:45 Drew Adams
  2007-03-26 13:33 ` Mathias Dahl
  0 siblings, 1 reply; 6+ messages in thread
From: Drew Adams @ 2007-03-25 20:45 UTC (permalink / raw)
  To: Emacs-Devel

I wonder if it wouldn't be better to systematically put the variable's value
last in the *Help* buffer for `C-h v'?

Consider, for example, what you see for something like
`font-lock-syntax-table':

 font-lock-syntax-table is a variable defined in `font-lock.el'.
 Its value is shown below.

 Documentation:
 Non-nil means use this syntax table for fontifying.
 If this is nil, the major mode's syntax table is used.
 This is normally set via `font-lock-defaults'.

 Value:
 #^[t nil
      (3)
      (3)
 ...
         (2)
         nil syntax-table]
      syntax-table]

 Local in buffer font-lock.el; global value is nil

 [back]

The "..." here represents 12,228 lines. This is an extreme case, of course,
but wouldn't it always be best to put the value last? The information about
the local and global values, and the [back] button, are more convenient if
presented before the value, no?

We might also consider placing a second [back] button after the value, if it
is longer than, say, 50 lines.

^ permalink raw reply	[flat|nested] 6+ messages in thread

* Re: put value last in *Help* buffer for C-h v?
  2007-03-25 20:45 put value last in *Help* buffer for C-h v? Drew Adams
@ 2007-03-26 13:33 ` Mathias Dahl
  2007-03-26 15:12   ` Drew Adams
  2007-03-26 23:14   ` Richard Stallman
  0 siblings, 2 replies; 6+ messages in thread
From: Mathias Dahl @ 2007-03-26 13:33 UTC (permalink / raw)
  To: Drew Adams; +Cc: Emacs-Devel

> I wonder if it wouldn't be better to systematically put the variable's value
> last in the *Help* buffer for `C-h v'?

I think I agree. It is a bit strange to see the value at the beginning
of the buffer sometimes and sometimes not (because it is "large").
Shouldn't we strive for a consistent user interface if we can?

> but wouldn't it always be best to put the value last? The information about
> the local and global values, and the [back] button, are more convenient if
> presented before the value, no?

I agree, it seems logical to keep all information about the variable
together, in one block.

> We might also consider placing a second [back] button after the value, if it
> is longer than, say, 50 lines.

I have no strong opinion on this apart from thinking that this too is
inconsistent; as a user I want to be able to trust that the same user
interface widgets are available each time I execute a certain
operation. However, I it might look goofy to see something like this:

  [back]
  Value:
   t
  [back]

/Mathias

^ permalink raw reply	[flat|nested] 6+ messages in thread

* RE: put value last in *Help* buffer for C-h v?
  2007-03-26 13:33 ` Mathias Dahl
@ 2007-03-26 15:12   ` Drew Adams
  2007-03-27 11:16     ` Mathias Dahl
  2007-03-26 23:14   ` Richard Stallman
  1 sibling, 1 reply; 6+ messages in thread
From: Drew Adams @ 2007-03-26 15:12 UTC (permalink / raw)
  To: Mathias Dahl; +Cc: Emacs-Devel

> > We might also consider placing a second [back] button after the
> > value, if it is longer than, say, 50 lines.
>
> I have no strong opinion on this apart from thinking that this too is
> inconsistent; as a user I want to be able to trust that the same user
> interface widgets are available each time I execute a certain
> operation. However, I it might look goofy to see something like this:
>
>   [back]
>   Value:
>    t
>   [back]

That's why I said "if it is longer than, say, 50 lines." In the case you
gave, the value takes up only one line.

Make it 1000 lines instead of 50, if you like. I figured that if you have to
scroll down, then another [back] button could be helpful.

^ permalink raw reply	[flat|nested] 6+ messages in thread

* Re: put value last in *Help* buffer for C-h v?
  2007-03-26 13:33 ` Mathias Dahl
  2007-03-26 15:12   ` Drew Adams
@ 2007-03-26 23:14   ` Richard Stallman
  2007-03-27 11:18     ` Mathias Dahl
  1 sibling, 1 reply; 6+ messages in thread
From: Richard Stallman @ 2007-03-26 23:14 UTC (permalink / raw)
  To: Mathias Dahl; +Cc: drew.adams, emacs-devel

    I think I agree. It is a bit strange to see the value at the beginning
    of the buffer sometimes and sometimes not (because it is "large").
    Shouldn't we strive for a consistent user interface if we can?

Consistency is not the only criterion.  When the value is short,
it is convenient to see it near the top, so that you don't have
to scroll down to find it.

^ permalink raw reply	[flat|nested] 6+ messages in thread

* Re: put value last in *Help* buffer for C-h v?
  2007-03-26 15:12   ` Drew Adams
@ 2007-03-27 11:16     ` Mathias Dahl
  0 siblings, 0 replies; 6+ messages in thread
From: Mathias Dahl @ 2007-03-27 11:16 UTC (permalink / raw)
  To: Drew Adams; +Cc: Emacs-Devel

> >   [back]
> >   Value:
> >    t
> >   [back]
>
> That's why I said "if it is longer than, say, 50 lines." In the case you
> gave, the value takes up only one line.

Sorry for being unclear; my point was that we SHOULD, in principle,
always print out the second [back], because of consistency. But at the
same time I do not agree with myself because I think my own "rule"
would create goofy situation like above. In other words, don't listen
to me...

> Make it 1000 lines instead of 50, if you like. I figured that if you have to
> scroll down, then another [back] button could be helpful.

Yes, and I agree.

^ permalink raw reply	[flat|nested] 6+ messages in thread

* Re: put value last in *Help* buffer for C-h v?
  2007-03-26 23:14   ` Richard Stallman
@ 2007-03-27 11:18     ` Mathias Dahl
  0 siblings, 0 replies; 6+ messages in thread
From: Mathias Dahl @ 2007-03-27 11:18 UTC (permalink / raw)
  To: rms; +Cc: drew.adams, emacs-devel

> Consistency is not the only criterion.  When the value is short,
> it is convenient to see it near the top, so that you don't have
> to scroll down to find it.

True, it is convenient if the description is so large that the value
will end up below so that you have to scroll.

^ permalink raw reply	[flat|nested] 6+ messages in thread

end of thread, other threads:[~2007-03-27 11:18 UTC | newest]

Thread overview: 6+ messages (download: mbox.gz follow: Atom feed
-- links below jump to the message on this page --
2007-03-25 20:45 put value last in *Help* buffer for C-h v? Drew Adams
2007-03-26 13:33 ` Mathias Dahl
2007-03-26 15:12   ` Drew Adams
2007-03-27 11:16     ` Mathias Dahl
2007-03-26 23:14   ` Richard Stallman
2007-03-27 11:18     ` Mathias Dahl

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).