| name | Documentation Issue |
|---|---|
| about | Report missing, unclear, or incorrect documentation |
| title | [DOCS] |
| labels | documentation |
| assignees |
What part of the documentation is affected?
- README.md
- Function reference
- Examples
- Code comments
- Contributing guide
- Other: _____________
Link or section: Provide a link or describe which section of the documentation is affected.
Describe what's missing, unclear, or incorrect in the documentation.
Current documentation:
# Quote or describe the current documentation
What's wrong with it:
- Missing information
- Incorrect information
- Unclear/confusing
- Out of date
- Broken link
- Typo/grammar
- Other: _____________
What should be added/changed:
# Describe or provide the corrected documentation
Why this is important: Explain why this documentation improvement matters (e.g., helps new users, clarifies confusion, etc.)
Add any other context, screenshots, or examples here.
- I'm willing to submit a PR to fix this documentation
- I'm just reporting the issue