Improve extended Exordium help #237
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Emacs-30 snapshot has started producing error messages with backtick/tick pair for symbols.
`helpful-mode` is derived from `special-mode`. The latter is the only mode that has been added to `show-paren-predicate` in Emacs-29. Yet it's very helpful to have visual help in `helpful-mode`.
When completing any of the `helpful` commands, for example `helpful-function` (`C-h f`), `helpful-variable` or (`C-h v`) display details of the completion. This is ahieved by using helm provided function, that is by default used to provide affixations for symbols (i.e., when using `describe-function` or `describe-variable`). BREAKING CHANGE: Use built-in `completions-detailed` as per helm advice and hide it behind a `exodrium-help-extenstions` flag
pkryger
requested review from
philippe-grenet and
steve-downey
as code owners
pkryger
force-pushed
the
help-improvements
branch
2 times, most recently
from
82fa04e to
32c965b
Compare
When using one of `helpful` commands (for example `helpful-callable`), it is possible to invoke `helm`'s persistent action that will describe currently selected symbol by hitting `C-j`. Example usage: - call `helpufl-callable`, - type something to narrow list of candidates (for example `message`), - select one of the candiates by moving selection in the `helm` completion buffer, using `C-n`/`C-p`), Insetead of hitting `RET` (that would dissmiss the `helm` completino buffer and pop up a new `helpful` buffer describing the selected symbol), you can now type `C-j` to just preview the selected symbol. This enables at least a couple workflows: - You can rapidly browse documentation for multiple narrowed symbols (for example when searching for a function or a variable) by hitting `C-j` on successive candidates. - You can just take peek a symbol documentation by hitting `C-j` and then dismiss both `helm` and `helpful` buffers by hitting `C-g` and go back to the window configuration that was before calling `helpful` command.
pkryger
force-pushed
the
help-improvements
branch
from
32c965b to
372838e
Compare
|
@philippe-grenet, @steve-downey, just a friendly reminder about this PR. Let me |
|
I've been meaning to explore +1 |
Glad you found it useful. And thanks for review. For me it's |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
This PR aims at improving experience when searching for help in Emacs. Just a
short enumeration of changes:
casual- I found it super useful for modes I use only casually (seewhat I did there 🤪),
helpfulbuffers to stick to the same window,helpful- display extradetails and allow to peek at docstring (like in
helm-M-x),helpbuffers to use clean buttons (i.e., remove ticks around thingsthat are clickable and should be displayed using appropriate face), and stick
to the same window when clicking around,
smergemode to recenter around the first unmerged,As usual, please see individual commits for more details.