ti.sil/pr-agent
1
0
Fork 0
mirror of https://github.com/qodo-ai/pr-agent.git synced 2025-12-12 19:05:18 +00:00
Code Issues Projects Releases Packages Wiki Activity Actions
pr-agent/docs/ADD_DOCUMENTATION.md
Hussam.lawen 85f64ad895
update readme and user guide
2023-10-02 10:11:28 +03:00

729 B
Raw Blame History

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:

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 ...".