xiaxinhang/pr-agent
1
0
Fork 0
mirror of https://github.com/qodo-ai/pr-agent.git synced 2025-07-02 11:50:37 +08:00
Code Issues Packages Projects Releases Wiki Activity
Files
1b22e59b4b9501da77ea7844cbb1a796201a9bb9
pr-agent/docs/ADD_DOCUMENTATION.md
mrT23 07abf4788c docs: Update image URLs in markdown files
2023-12-03 08:41:09 +02:00

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