Display cheatsheet in a separate buffer #3681
Conversation
|
Can you share some screenshot showing the proposed UI? |
|
Seems we have forgotten to document this functionality completely, so it will also be nice to add some section about the |
I've updated the description with a screenshot. Right now, it is nothing fancy, but it is a base on which we can iterate. |
Okay, I'll do it. In the near future, I plan a series of changes. Should I do this now or after that? |
You can do this later then. For now just add some changelog entry about the new way to display the cheatsheet. |
|
I've updated the changelog. Since this is my first time doing so, I hope I did it correctly, though I was unsure about the order of the entries, as they don't appear to be ordered by PR number. |
The ordering doesn't matter much, as long changes are in the right section. Thanks! |
While thinking about #3678 on how we can improve the current cheatsheet interface, I came up with the idea that we need to make it possible to display cheatsheet in a separate buffer.
The current cheatsheet is a subset of the official cheatsheet, displaying only functions using completion interface. However, by displaying cheatsheet in a buffer, we can have a richer output and make it identical to the official cheatsheet in terms of the information it provides. For example, we can make headings clickable to link to documentation, and we can display literals and other strings from the official cheatsheet that are currently omitted.
Here is how it looks at this point:
Following the naming pattern of
cider-aproposandcider-apropos-select, I've divided this functionality into two commands:cider-cheatsheet, which displays cheatsheet in the*cider-cheatsheet*buffer, andcider-cheatsheet-select, which provides a completion interface (as the currentcider-cheatsheetcommand does).