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

Jump to module from function documentation #327

Merged
merged 5 commits into from Oct 30, 2017

Conversation

bschmeck
Copy link
Contributor

When viewing the documentation for a function, this PR modifies the alchemist-help-minor-mode-map to allow you to jump to documentation for that function's module by hitting the m key. E.g. if you're reading about String.split/1, you can jump to the documentation for String in a single keystroke.

@tonini
Copy link
Owner

tonini commented Oct 23, 2017

@bschmeck Thanks for this contribution.

Could you update the docs about this new keybinding too?

@bschmeck
Copy link
Contributor Author

@tonini Just added the keybinding to "Basic Usage" docs and the keybinding summary. Let me know if there's some other place that I missed.

@tonini tonini merged commit 4beb4c9 into tonini:master Oct 30, 2017
@tonini
Copy link
Owner

tonini commented Oct 30, 2017

@bschmeck many thanks for the contribution! ❤️ 💚 💛

whysoserious pushed a commit to whysoserious/alchemist.el that referenced this pull request Dec 25, 2017
* Jump to module from function documentation

* Use existing functions to extract module from current search

* Add docstring to alchemist-help-module

* Document the `m` keybinding

* Inadvertantly changed 's' to 'm' when copy-pasting
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.

None yet

2 participants