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

counsel.el (counsel-mode): Display local keymap in mode doc #1718

Closed
wants to merge 1 commit into from

Conversation

@nxtr
Copy link
Contributor

@nxtr nxtr commented Aug 16, 2018

Just convenience to display remapped commands and any key bindings in
describe-mode/-minor-mode.

Convenience to display remapped commands and any key bindings in
describe-mode/-minor-mode.
@basil-conto
Copy link
Collaborator

@basil-conto basil-conto commented Aug 17, 2018

I'm currently AFK so I can't check, but IIRC such keymap listings are automagically added to minor and/or major mode docstrings in at least some Emacs versions, FWIW.

@nxtr
Copy link
Contributor Author

@nxtr nxtr commented Aug 17, 2018

No version that i'm aware of, at least not in debian stable (strech) 25.1 which I regard as baseline.
So it's convenient having bindings/remap included in C-h m, describe-minor-mode etc.
Nevertheless, describe-bindings will list them all, but this is maybe for the more experienced user.

@basil-conto
Copy link
Collaborator

@basil-conto basil-conto commented Aug 17, 2018

I agree that it's convenient to have such listings, that's why (IIRC) define-derived-mode appends such a listing if one does not already exist. Anyway, I was just mentioning this as an aside, not as an argument against the PR.

@nxtr
Copy link
Contributor Author

@nxtr nxtr commented Aug 17, 2018

Cool! Ahh, but in this case the doc arg in define-minor-mode exists so nothing is constructed/added.
With a nilled doc arg we'll miss out on the remapped built-ins wording.

Edit: * define-minor-mode

@abo-abo abo-abo closed this in 298b9b5 Aug 20, 2018
@abo-abo
Copy link
Owner

@abo-abo abo-abo commented Aug 20, 2018

Thanks.

@nxtr
Copy link
Contributor Author

@nxtr nxtr commented Aug 20, 2018

You're welcome.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Linked issues

Successfully merging this pull request may close these issues.

None yet

3 participants