Skip to main content
GitHub GitLab
Git Integration (formerly Qodo Merge) – AI code review agents for pull requests. This documentation describes the Qodo v1 experience. For the Qodo v2 documentation, click here.
The add_docs tool scans the PR code changes, and automatically suggests documentation for any code components that changed in the PR. The add_docs tool supports the programming languages: Python, Java, C++, JavaScript, TypeScript, C#.

​
How to use the add_docs tool

Manual usage Comment on the PR: 
/add_docs
You can also state a name of a specific component in the PR to get documentation only for that component: 
/add_docs component_name
This tool can also be triggered interactively by using the analyze tool.

​
Configuration options

Configure the add_docs tool by setting configurations under the pr_add_docs part in your configuration file.
Possible configurationsDefault valueWhat they do
docs_stylesphinxThe exact style of the documentation (for python docstring). You can choose from: google, numpy, sphinx, restructuredtext, plain.
extra_instructionsnoneOptional extra instructions for the tool. For example: “focus on the changes in the file X”, “Ignore changes in …”

​
Example usage