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

Please add a screenshot with command docstrings shown to the README #332

Open
piotrklibert opened this issue Jan 8, 2022 · 2 comments
Open

Comments

@piotrklibert
Copy link

I'm not sure if there are many people like me, but I avoided using this project for years because it seemed pretty useless to me, based on the screenshots and description in the README. At the end of last year, I did a major overhaul of my Emacs config and decided to take a closer look at the customization options. There I discovered that which-key is able to also display docstrings - and that is immensely more useful to me than displaying just the command names. Coupled with the ability to set columns' widths and paging, it gives a wonderful, quick overview of what will really happen when I press some key. I think "seeing is believing" has a certain amount of truth to it, so if there are others like me, including a screenshot like this will help them decide to use which-key:

screenshot_2022-01-08_1103

@justbur
Copy link
Owner

justbur commented Feb 14, 2022

I can do that. Do I have your permission to use this one?

@piotrklibert
Copy link
Author

piotrklibert commented Aug 21, 2022

@justbur Obviously, yes! Sorry, I didn't get the notification for some reason; fortunately, I'm cleaning up my TODO and found a mention of this ticket. Sorry it took so long :)

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