xiaxinhang/pr-agent
1
0
Fork 0
mirror of https://github.com/qodo-ai/pr-agent.git synced 2025-07-10 07:40:39 +08:00
Code Issues Packages Projects Releases Wiki Activity

Add to user tools guide

Browse Source
This commit is contained in:
Hussam.lawen
2023-10-01 19:51:15 +03:00
parent b2369c66d8
commit e941fa9ec0
7 changed files with 24 additions and 49 deletions
Download Patch File Download Diff File Expand all files Collapse all files

14
docs/ADD_DOCUMENTATION.md Normal file
View File

@ -0,0 +1,14 @@
# Add Documentation Tool
The `add_docs` tool scans the PR code changes, and automatically suggests documentation for the undocumented code components (functions, classes, etc.).
It can be invoked manually by commenting on any PR:
```
/add_docs
```
For example:
<kbd><img src=./../pics/add_docs_comment.png width="768"></kbd>
<kbd><img src=./../pics/add_docs.png width="768"></kbd>
### Configuration options
- `docs_style`: The exact style of the documentation (for python docstring). you can choose between: `google`, `numpy`, `sphinx`, `restructuredtext`, `plain`. Default is `sphinx`.
- `extra_instructions`: Optional extra instructions to the tool. For example: "focus on the changes in the file X. Ignore change in ...".