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

Enhancement: Toggle Quick Doc using key map #56

Closed
rafaeldelboni opened this issue Aug 21, 2019 · 3 comments
Closed

Enhancement: Toggle Quick Doc using key map #56

rafaeldelboni opened this issue Aug 21, 2019 · 3 comments
Labels
enhancement New feature or request

Comments

@rafaeldelboni
Copy link
Sponsor Contributor

I personally don't like the quickdoc showing up all time, but would nice to have a way to show it using some key mapping or when I try to get the doc of a function that doesn't have one.

@Olical Olical added the enhancement New feature or request label Aug 21, 2019
@Olical
Copy link
Owner

Olical commented Aug 21, 2019

So you can kind of bypass all of the existing mechanisms by mapping a key to call conjure#notify("quick_doc"), that will get it displaying when you want it. To clear it you'll have to map something to ConjureClearVirtual.

Rather than adding a new mapping this probably requires a little thought around how virtual text (and quick doc) should work. Right now the clearing of virtual text is dependant on quick doc settings which is far from ideal.

I have a backlog entry in my trello to address this and rethink how this passive information works. I'll keep thinking on it, I really want to push for a well documented and stable v1.0.0 over the next week or so though.

I have next week off in between jobs and I'm hoping to cut an initial "stable" release :D

@rafaeldelboni
Copy link
Sponsor Contributor Author

Hey thanks for your help!

I just solved this with the following in my .vimrc file

command! -range ConjureQuickDoc call conjure#notify("quick_doc")
au FileType clojure nmap <leader>gd :ConjureQuickDoc<cr>

@Olical
Copy link
Owner

Olical commented Aug 21, 2019

Sweet, glad that worked out for you! I'm hoping I can expose enough of the internals that these kind of custom mappings are really easy to set up and use. I will look at replacing some of the quick doc / virtual text plumbing soon-ish though.

Hopefully it'll be a little more predictable and customable when I'm done with it.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
enhancement New feature or request
Projects
None yet
Development

No branches or pull requests

2 participants