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

Support Class Docstrings #5

Open
Sam-Armstrong opened this issue Nov 6, 2023 · 0 comments
Open

Support Class Docstrings #5

Sam-Armstrong opened this issue Nov 6, 2023 · 0 comments
Labels
enhancement New feature or request

Comments

@Sam-Armstrong
Copy link
Owner

Currently, DocPilot only supports adding docstrings to functions; it would be good to also support classes. Doing this will require the following (according to the code at the time this issue was created):

  • Adding logic to the script to find the location to put the docstring for a class (which will be different to the logic for finding a function). A new generate_cls_docstring function should probably be created alongside additional logic in add_docstring to achieve this.
  • Engineering the existing class prompt (resources/class_prompt.txt) to get the best results
@Sam-Armstrong Sam-Armstrong added the enhancement New feature or request label Nov 6, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
enhancement New feature or request
Projects
None yet
Development

No branches or pull requests

1 participant