Skip to content

Latest commit

 

History

History
24 lines (19 loc) · 1.18 KB

ADD_DOCUMENTATION.md

File metadata and controls

24 lines (19 loc) · 1.18 KB

Add Documentation Tool 💎

The add_docs tool scans the PR code changes, and automatically suggests documentation for any code components that changed in the PR (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 ...".

Notes

  • Language that are currently fully supported: Python, Java, C++, JavaScript, TypeScript.
  • For languages that are not fully supported, the tool will suggest documentation only for new components in the PR.
  • A previous version of the tool, that offered support only for new components, was deprecated.