vim-pydocstring
vim-pydocstring copied to clipboard

Published 20 hours ago •

Reame
Issues

Add support for class attribute list auto-generation

Open zoj613 opened this issue 1 year ago • 8 comments

Is it possible to add support for auto-generating class attributes? According the numpydocs convention, class attributes are encouraged to be included when adding docstring for a class. Something like:


class Test:
   """Test.
    
    Attributes
    ----------
    name : str
    another : float
   """
   name: str
   another: float

Currently, the behaviour when using the numpy style is:


class Test:
   """Test.
   """
   name: str
   another: float

If this is already supported via a particular setting please feel free to direct me to the relevant documentation.

Jul 14 '22 10:07 zoj613

@zoj613 Thank you for comment. Sorry, currently not supported.

This is interesting. I'll implement this feature to doq. But currently my main business is bit a busy, so I hope I hope you'll wait finish this implementation 🙏

Jul 18 '22 06:07 heavenshell

This issue has been automatically marked as stale because it has not had recent activity. It will be closed if no further activity occurs. Thank you for your contributions.

Jul 31 '22 08:07 stale[bot]

This issue has been automatically marked as stale because it has not had recent activity. It will be closed if no further activity occurs. Thank you for your contributions.

Aug 13 '22 05:08 stale[bot]

This issue has been automatically marked as stale because it has not had recent activity. It will be closed if no further activity occurs. Thank you for your contributions.

Sep 21 '22 04:09 stale[bot]

This issue has been automatically marked as stale because it has not had recent activity. It will be closed if no further activity occurs. Thank you for your contributions.

Nov 12 '22 21:11 stale[bot]

This issue has been automatically marked as stale because it has not had recent activity. It will be closed if no further activity occurs. Thank you for your contributions.

Jan 07 '23 22:01 stale[bot]

This issue has been automatically marked as stale because it has not had recent activity. It will be closed if no further activity occurs. Thank you for your contributions.

May 22 '23 00:05 stale[bot]

This issue has been automatically marked as stale because it has not had recent activity. It will be closed if no further activity occurs. Thank you for your contributions.

Jun 18 '23 05:06 stale[bot]