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
Access docstrings of defs and decls #1166
Comments
Is there something you would like to use this feature for, precisely? |
Yes! See the use cases! |
Your usecases are just general ideas of what would be doable, do you need this feature to code something in particular? |
I think I fail to see the difference. But perhaps you're asking if lacking this severly blocks my workflow. If so, the answer is no. |
If you're asking for features that we don't need, the incentive to taking the risk of introducing more bugs into the codebase melts away, so I'm asking if you're working on a script that would make use of those features. This is not about the relevancy of the request, but about if we plan on implementing a feature just for the sake of having it. |
Thank you for your reply. I hear your concern about bloating the codebase with features we do not need. I share this care about Kakoune. For example: I implemented my own Regarding this and the other feature requests I raised today I do not think they introduce extra baggage, since:
Just as you, I have put my confidence in this editor, too. I have spent over 100 hours to configure and think about Kakoune. The issues and feature requests I raise are for the benefit of myself but also for the benefit of all of us. Please, next time you are concerned that I carelessly want to bloat the code base, raise this and state why you estimate the introduced complexity does not outweigh the benefits. |
While using neovim, I constantly use fzf.vim for this precise purpose : https://github.com/junegunn/fzf.vim Being able to fuzzy search any list from kakoune in a quick and uniform way really improved my workflow. In fact one of my last request about searching history is directly related #1130 So yes, the more info we can get out of this black box, the better. |
I agree that it would be nice to expose the docstrings for a few reasons, mainly allow better integration with external tools providing UI, and the ability to generate documentation from the code. I am not sure about the interface though, it seems wrong to just put all the infos in a single env var, but on the other hand, using on env var per command might get convoluted to access, as the full var name needs to appear in the %sh{...} block. Also, we use |
related PR adding missing docstrings to |
Related #1605 |
I propose
$kak_def_docstrings
, and$kak_decl_docstrings
to hold all defineddef
s anddecl
s together with their docstrings.Use cases:
map
also had docstrings (Add -docstring switch to :map command #105), and submap info were options (Use options for info boxes in the submaps (user, view, goto, etc) #1165) one could combine this to set the submap info.The text was updated successfully, but these errors were encountered: