Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Add support for class attribute list auto-generation #139

Open
zoj613 opened this issue Jul 14, 2022 · 8 comments
Open

Add support for class attribute list auto-generation #139

zoj613 opened this issue Jul 14, 2022 · 8 comments

Comments

@zoj613
Copy link

zoj613 commented Jul 14, 2022

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.

@zoj613 zoj613 changed the title Class attribute list auto-generation Add support for class attribute list auto-generation Jul 14, 2022
@heavenshell
Copy link
Owner

@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
Copy link

stale bot commented Jul 31, 2022

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 stale bot added the wontfix label Jul 31, 2022
@stale
Copy link

stale bot commented Aug 13, 2022

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 stale bot added the wontfix label Aug 13, 2022
@stale
Copy link

stale bot commented Sep 21, 2022

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 stale bot added the wontfix label Sep 21, 2022
@stale stale bot closed this as completed Nov 2, 2022
@heavenshell heavenshell reopened this Nov 2, 2022
@stale
Copy link

stale bot commented Nov 12, 2022

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 stale bot added the wontfix label Nov 12, 2022
@stale
Copy link

stale bot commented Jan 7, 2023

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 stale bot added the wontfix label Jan 7, 2023
@stale
Copy link

stale bot commented May 22, 2023

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 stale bot added the wontfix label May 22, 2023
@stale
Copy link

stale bot commented Jun 18, 2023

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 stale bot added the wontfix label Jun 18, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

No branches or pull requests

2 participants