howm: Update help generation for modes#16
Conversation
Update the modes to generate their help text from the mode-maps, rather than list the contents of the menu manually.
|
Thanks for pointing that out. Applying this PR seems like a better option if the current lists are not good enough and fixing them would be too much trouble. What do you think? Could you give some examples of issues with the current lists, including my awkward English, of course? :) Handmade lists can offer higher quality if they are well-maintained. So, there seems to be pros and cons to this PR.
As for "M-x ..." in the current lists, I purposely included them for users' information, or I may have just forgotten to update the keymaps. I probably didn't notice the latter case since I use customized keymaps myself, as is common for long-time emacs fans. |
|
Thanks for taking a look at this so quickly, and for your thoughtful comments. (Also, your English is great!) My inspiration for looking at this was that the help text was not showing the key mappings for me. For example, when viewing all notes, with my point in the howm-view-summary, and pressing After making the change to I do agree that a well curated list could be helpful, but as it was I needed to look up the mappings a different way. I found that |
|
(AIs are great at fixing English today, but the docstrings were written a long time ago. :p) I'm unable to reproduce the issue.
It seems I've forgotten the "Quit" binding, but the other items seem OK. Are you using any customizations, like a VI emulator? The fact that you can use |
I will keep debugging this locally, as I know that it works correctly for you, and agreeing that the curated help is more useful that the generated help. I'll let you know if I figure out what's happening here. |
|
ac8eed0 should fix the issue. (cf. Info > Elisp > Documentation Tips > local map) https://github.com/kaorahi/howm/tree/fix16_describe_mode It seems we need I usuall add |
|
That's interesting. I'm glad that you were able to find what changed and were able to create a fix. :) My full name and email sounds fine. I believe it will be Chris Gerber chris@theGerb.com. Thanks again for your help, and feel free to close this PR. |
|
I've merged the above ac8eed0 into the master branch. Please let me know if you run into any issues. |
|
I just updated my machine and the help text looks perfect. Thanks for figuring out how to fix this! |
Update the modes to generate their help text from the mode-maps, rather than list the contents of the menu manually.
Currently when I type
C-h mto rundescribe-mode, some of the functions show keybindings ofM-x <function>, rather than the keys that are bound. We can both fix this and simplify the code, by using the mode-maps like was already done forhowm-remember-mode-map.