gianfrancodemarco/Auto Doc Generation
Automatically generate and update docstrings in Python files
View on GitHubTrust Signals
- Scorecard Score
- not yet scored
- Maintenance Recency
- Stale
- License
- None
Inputs
| name | description | required | default |
|---|---|---|---|
| openai-api-key | API key for OpenAI | yes | — |
| reviewers | Reviewers for the pull request | no | "" |
| paths | List of directories and/or files to scan | yes | . |
| code-entities | List of code entities to generate docstrings for | no | module,class,function |
| function-prompt | Prompt to use for generating docstrings for functions | no | "" |
| class-prompt | Prompt to use for generating docstrings for classes | no | "" |
| module-prompt | Prompt to use for generating docstrings for modules | no | "" |
Outputs
no outputs