search

kkoomen / vim-doge

(Do)cumentation (Ge)nerator for nearly 20 languages 📚 Generate proper code documentation with a single keypress. ⚡️🔥
GNU General Public License v3.0
1.01k stars 51 forks source link

Has DogeCreateDocStandard feature been removed on v4? #636

Closed amano-takahisa closed 1 year ago

amano-takahisa commented 1 year ago

When generating the numpy docstring, I would also like to add an Example section header. I have read past issues and thought it could be customized by DogeCreateDocStandard, but I also found the release note which sounds like that it is not available from V4.

Templating limitations: v3 contained basic templating functionality that was custom written, as opposed to v4 that uses Tera

Is there any way to use a template other than the one currently provided?

kkoomen commented 1 year ago

Hi.

Yes, custom user-defined templates has been removed in v3.18.0 already, the release note you're referring to was another issue and is not related to custom user-defined templates. because it was too much of a hassle to maintain.

The Example sections in comments are generally extra fields people can add according to most documentation standards and are mainly used by API devs or those that are building public packages. Vim-doge helps with creating the initial skeleton of the docblock and you can add more fields whenever needed by yourself.