feature request: make describe-key work with god-mode

[andyjda]

feature request: make describe-key work with god-mode

[darth10]

Done in #146.

[andyjda]

thanks for flagging this @tangxinfa!
I'm fairly certain this will be fixed with an unwind-protect form. I was not aware of this form when I wrote the god-mode-describe-key function: it should remove the hook in all situations. Please try to reproduce your error with the updated code and let me know your experience.

@darth10 I have created a pull request with my fix, let me know your thoughts

[darth10]

Great idea @andyjda!
This is currently a limitation of God mode, but it's something that can be improved.

[andyjda]

Great!
Do you know if there could be a more elegant/effective way to do this?
I'm not too familiar with the code, but I couldn't think of a way to achieve points 1) and 2) (as mentioned above) without overhauling a bit of the package. I'm not sure that'd be worth it.

If this is as good as we can get for now, should we include it in the code? Let me know if you have any edits/suggestions: I can write it up and do a pull-request (I think I'll also edit the README to outline the updated behavior for describe-key)

[darth10]

I think advice functions are fine as long as they're removed when the mode is switched off.
But you're right, they can help with describe-key without a major overhaul of the codebase.

I'll get to this soon, but am more than happy to accept any contributions for this improvement.

[andyjda]

that's a great point, I'll make sure to remove the advice when the mode switches off.
I can work on this and get you a working solution in a few days. I'll let you know when it's ready

[andyjda]

Hey @darth10 here's my PR for this feature: #146
I think I got closer to my initial idea. All the useful information is now displayed in the Help buffer.

Also, while working on it I noticed a few minor compilation/flycheck warnings. I took the liberty of fixing these and made a separate PR for them: #147

Hope this is helpful! Let me know your thoughts

[darth10]

Thanks for those PRs @andyjda!
I haven't had a chance to look at them as I'm travelling, but I'll take a look this weekend.

[andyjda]

sounds great, no rush! happy travels

[tangxinfa]

I found in rare cases god-mode--help-fn-describe-function is leave in
help-fns-describe-function-functions hook, break the system's describe-key
and describe-function functioning in other non god-mode buffers.

error message:

god-mode--help-fn-describe-function: Wrong type argument: number-or-marker-p, nil