Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Show variable name in helpful-variable #19

Closed
diamond-lizard opened this issue Sep 1, 2017 · 6 comments
Closed

Show variable name in helpful-variable #19

diamond-lizard opened this issue Sep 1, 2017 · 6 comments

Comments

@diamond-lizard
Copy link

The helpful-variable function should show the name of the variable it's describing.

@Wilfred
Copy link
Owner

Wilfred commented Sep 5, 2017

It's already mentioned in the mode line -- do you think it would be useful in the buffer too? If so, where?

@diamond-lizard
Copy link
Author

Oh, I didn't even notice that. I had gotten too used to seeing it displayed in the buffer when using describe-variable.

I think it would be useful, and the best place for it would be at the top of the buffer, just as describe-variable does it. That's where my eyes most naturally go first, and usually it's the name and value of the variable which I most want to see. The documentation and other info can come later.

By the way, maybe I should open a new issue for this, as this issue is just for the name of the variable, but it would be nice to see the value as well.

@Wilfred
Copy link
Owner

Wilfred commented Sep 5, 2017

The value is now shown, see #15.

@diamond-lizard
Copy link
Author

I see. I think I must have had an older version of helpful which didn't show it. Now that I updated to the newest version, I see the value. Thank you.

I still think it would be most helpful at the top of the buffer, though, rather than buried somewhere down below. The name and value are the most important things I look for when getting help on a variable.

@diamond-lizard
Copy link
Author

Today I happened to look at the value of auto-mode-alist and saw that it was a gigantic list. In this case, describe-variable prints the top of the help screen:

auto-mode-alist is a variable defined in `files.el'.
Its value is shown below.

I think that's a good approach for when the value of a variable can't be fit in to a line or two. As a user, I'd still be looking at the top of the screen for the value, but then be redirected lower down the screen by what I read in the expected place.

@Wilfred
Copy link
Owner

Wilfred commented Dec 10, 2017

I'm persuaded :). Fixed.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

2 participants