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

docs: document how to auto-trigger /add_docs via pr_commands

Browse Source
This commit is contained in:
jaexxin
2025-05-19 17:34:48 +09:00
parent 65d9269bf2
commit 31620a82c0
1 changed files with 19 additions and 0 deletions
Download Patch File Download Diff File Expand all files Collapse all files

19
docs/docs/tools/documentation.md
View File

@ -26,6 +26,25 @@ You can state a name of a specific component in the PR to get documentation only
/add_docs component_name /add_docs component_name
``` ```
## Automatic triggering
To automatically run the `add_docs` tool when a pull request is opened, configure your `.pr_agent.yaml` or `configuration.toml` as follows:
```toml
[github_app]
pr_commands = [
"/describe",
"/review",
"/improve",
"/add_docs"
]
```
!!! note
This behavior is **opt-in**; by default `/add_docs` only runs on manual invocation.
## Configuration options ## 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`. - `docs_style`: The exact style of the documentation (for python docstring). you can choose between: `google`, `numpy`, `sphinx`, `restructuredtext`, `plain`. Default is `sphinx`.