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

docs: improve formatting and readability of documentation

Browse Source
This commit is contained in:
ofir-frd
2025-02-21 10:38:18 +02:00
parent 1e98d27ab4
commit b2d8dee00a
13 changed files with 48 additions and 52 deletions
Download Patch File Download Diff File Expand all files Collapse all files

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

@ -27,7 +27,6 @@ You can state a name of a specific component in the PR to get documentation only
- `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 ...".
**Notes**
- Language that are currently fully supported: Python, Java, C++, JavaScript, TypeScript, C#.
- This tool can also be triggered interactively by using the [`analyze`](./analyze.md) tool.
!!! notes "Notes"
- The following languages are currently supported: Python, Java, C++, JavaScript, TypeScript, C#.
- This tool can also be triggered interactively by using the [`analyze`](./analyze.md) tool.