vim-doge
vim-doge copied to clipboard
kkoomen
Generate python class and module scope docstrings
Is your feature request related to a problem? Please describe. No
Describe the solution you'd like Class scope documentation serves to provide a description of what the class is and details on any class level parameters:
class Foo:
"""
Foo is a Thing that does Other Thing.
:param baz:
"""
baz: int
Module scope documentation:
"""
Foo serves to [...]
"""
import time
...
Describe alternatives you've considered
Additional context
+1.
Tracing to https://github.com/kkoomen/vim-doge/blob/master/helper/src/python/parser.rs and the associated tests it looks like only recognising functions is implemented.
It would be nice in the README to document what tags are supported for each language.
I've implement the PR #660 based on https://stackoverflow.com/a/3051356 with solely the addition of classes. I'm not supporting the import docstring because it's super rare to see that. It's quite common to add class docs, hence I support that. I'll do a new release soon and will notify it here.
