search

emacs-vs / ts-docstr

A document string minor mode using tree-sitter
https://emacs-vs.github.io/ts-docstr/
GNU General Public License v3.0
39 stars 4 forks source link

Integration with Yasnippet #4

Open d-miketa opened 1 year ago

d-miketa commented 1 year ago

It'd be nice if this package could support the yasnippet format for fields like function summaries and argument descriptions. Numpydoc features it as an option, see GIF towards the bottom of the README: https://github.com/douglasdavis/numpydoc.el

jcs090218 commented 1 year ago

Your request is a bit misleading. Do you want this package to integrate with yasnippet? And provide function summaries and argument descriptions as an option?

My question is, what would you want this package to work with yasnippet? Expand template? Triggering? Insert in the field? etc. Is the workflow like yasnippet?

Regarding the options, it can be another feature request whether the yasnippet is integrated.

P.S. Just want to clarify your requests! ;)

d-miketa commented 1 year ago

Sure, I'll try to be clearer! :)

I'm really only looking for the "insert in the field" and "jump to next field" functionality that Yasnippet already has (and that you can see in the GIF I linked to). While the current package solves insertion of the docstring template, this would help to quickly edit it.

jcs090218 commented 1 year ago

Thanks for the clarification! ❤️ I think this is indeed a nice feature to have!

I'm moving somewhere else from my country, so I probably wouldn't have too much time to do this! But I will keep this feature request in mind!

Feel free to open PRs if you are comfortable with elisp, or share for more exposure! May be other would like to help out!

Happy New Year! 🥳