search

heavenshell / vim-pydocstring

Generate Python docstring to your Python source code.
BSD 3-Clause "New" or "Revised" License
337 stars 53 forks source link

Add support for class attribute list auto-generation #139

Open zoj613 opened 2 years ago

zoj613 commented 2 years ago

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.

heavenshell commented 2 years ago

@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 🙏

stale[bot] commented 2 years ago

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.

stale[bot] commented 2 years ago

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.

stale[bot] commented 2 years ago

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.

stale[bot] commented 1 year ago

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.

stale[bot] commented 1 year ago

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.

stale[bot] commented 1 year ago

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.

stale[bot] commented 1 year ago

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.