smolagents-audit/.github/ISSUE_TEMPLATE/doc_improvement.md
2025-07-16 12:38:30 +02:00

1 KiB

name about title labels assignees
Documentation Improvement Report wrong or missing documentation DOC: documentation

Problem A clear and description of what is wrong or missing in the documentation.

Location of the documentation Provide the specific location of the documentation that needs improvement. Select what is applicable:

  • Function/Class/Method name: (if applicable: e.g., module.ClassName.method_name)
  • URL: (if applicable: e.g. https://huggingface.co/docs/smolagents/installation)

Suggested improvement A clear and concise description of the fix and improvement you suggest and why it is better.

Additional context (optional) Add any other context or screenshots about the documentation improvement here.


Checklist

  • I have searched the existing issues and have not found a similar issue.
  • I am willing to work on this issue and submit a pull request. (optional)