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

Display cheatsheet in a separate buffer #3681

Merged
merged 4 commits into from
May 27, 2024
Merged

Display cheatsheet in a separate buffer #3681

merged 4 commits into from
May 27, 2024

Conversation

katomuso
Copy link
Contributor

@katomuso katomuso commented May 26, 2024

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:
cheatsheet-buffer

Following the naming pattern of cider-apropos and cider-apropos-select, I've divided this functionality into two commands: cider-cheatsheet, which displays cheatsheet in the *cider-cheatsheet* buffer, and cider-cheatsheet-select, which provides a completion interface (as the current cider-cheatsheet command does).

@bbatsov
Copy link
Member

bbatsov commented May 26, 2024

Can you share some screenshot showing the proposed UI?

@bbatsov
Copy link
Member

bbatsov commented May 26, 2024

Seems we have forgotten to document this functionality completely, so it will also be nice to add some section about the cider-cheatsheet commands here https://docs.cider.mx/cider/usage/misc_features.html

@katomuso
Copy link
Contributor Author

Can you share some screenshot showing the proposed UI?

I've updated the description with a screenshot. Right now, it is nothing fancy, but it is a base on which we can iterate.

@katomuso
Copy link
Contributor Author

Seems we have forgotten to document this functionality completely, so it will also be nice to add some section about the cider-cheatsheet commands here https://docs.cider.mx/cider/usage/misc_features.html

Okay, I'll do it. In the near future, I plan a series of changes. Should I do this now or after that?

@bbatsov
Copy link
Member

bbatsov commented May 26, 2024

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.

@katomuso
Copy link
Contributor Author

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.

@bbatsov
Copy link
Member

bbatsov commented May 27, 2024

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!

@bbatsov bbatsov merged commit dd1fda0 into clojure-emacs:master May 27, 2024
39 checks passed
@katomuso katomuso deleted the cheatsheet-buffer branch May 27, 2024 14:45
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

Successfully merging this pull request may close these issues.

2 participants