ManimCommunity/manim

Update and improve documentation on tests

Open

#2502 opened on Jan 28, 2022

View on GitHub
 (4 comments) (0 reactions) (0 assignees)Python (17,820 stars) (1,378 forks)batch import
easyenhancementgood first issue

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

Tech stack
python
Domain
documentationtesting
Issue type
documentation
DifficultyEstimated implementation difficulty for a new contributor, from 1 for very small changes to 5 for expert-level work.
2
Estimated timeA rough time range for an experienced contributor to investigate, implement, test, and prepare a pull request.
1-3 hours
Activity statusHow available the issue appears right now: fresh, active, stale, blocked, or waiting on maintainer input.
stale
ClarityHow clearly the issue explains the expected change, acceptance criteria, and next step.
clear
Prerequisites
None
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
85
Research direction
Start by reading the current testing documentation at https://docs.manim.community/en/stable/contributing/testing.html. Identify missing sections about graphical unit tests and areas with awkward phrasing. Improve the content and structure without altering the underlying testing code. Since no maintainer clarification is needed, you can directly propose changes via a pull request.