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

helpful-function doesn't show documentation #10

Closed
DamienCassou opened this issue Aug 29, 2017 · 4 comments
Closed

helpful-function doesn't show documentation #10

DamienCassou opened this issue Aug 29, 2017 · 4 comments

Comments

@DamienCassou
Copy link
Contributor

When I type M-x helpful-function RET shell-quote-argument, I don't get the documentation of the function, except through it's source code. Is that expected? I would like a properly formatted documentation of each function so I can use helpful-function as a drop-in replacement for C-h f.

@DamienCassou
Copy link
Contributor Author

Left is helpful-function, right is describe-function.

screenshot

@Wilfred
Copy link
Owner

Wilfred commented Aug 29, 2017

Nope, that's not expected. Every function should show its documentation.

I can't actually reproduce this:

shell_quote

I'd initially guessed the issue was autoloading, but I'd expect to see 'this function has not been loaded' in the *Help* buffer if autoloading was the cause.

Are you seeing this with other functions?

@DamienCassou
Copy link
Contributor Author

I cannot reproduce anymore. I will reopen when and if it comes back. Sorry for the noise.

@Wilfred
Copy link
Owner

Wilfred commented Aug 30, 2017

I have an idea what happened here.

Earlier versions of Helpful only supported functions, so buffers only stored the symbol. Now that we support both variables and functions, there's a helpful--callable-p that needs to be set.

I'm guessing that you reloaded an existing results buffer after upgrading? That would have had helpful--callable-p as nil, so it would be trying to show the docstring of a variable called shell-quote-argument.

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