ManimCommunity / ManimCommunity/manim
Update and improve documentation on tests
Open
Beginner friendly
Nobody has claimed this yet.
easy
enhancement
good first issue
- Dominant language
- Python
- Stars
- 40.9k
- Forks
- 3.1k
- Avg merge
- 3d 12h
- Merged PRs (30d)
- 25
Description
Enhancement proposal
Our documentation on tests is slightly outdated (it does not mention graphical unit tests for video). In addition, the phrasing and grammar are awkward at many places and could do with a copyedit.
Additional comments
Contributor guide
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
Research direction
Start with the contributing/testing documentation at the linked testing page and review its current coverage of graphical unit tests for video. Copyedit the awkward phrasing and grammar while preserving the existing guidance, then confirm the page explains graphical video tests and reads clearly when the documentation build or preview is checked.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- python
- Domain
- documentation, testing
- Issue type
- Documentation
- Difficulty
- 2/5
- Estimated time
- Half a day
- Activity status
- Quiet
- Clarity
- Mostly clear
- Newbie friendliness
- 62/100