ManimCommunity/manim

Add documentation about unit conversion feature

Open

#2,512 opened on Jan 29, 2022

View on GitHub
 (2 comments) (0 reactions) (1 assignee)Python (1,378 forks)batch import
documentationenhancementgood first issue

Repository metrics

Stars
 (17,820 stars)
PR merge metrics
 (Avg merge 90d 10h) (31 merged PRs in 30d)

Description

Enhancement proposal

This feature was implemented in https://github.com/ManimCommunity/manim/pull/742, but there isn't any documentation about this.

# 50px -> Munit
>>> 50 * unit.Pixels
0.37037037037037035
# 90 degrees to radians
>>> 90 * unit.Degrees
1.5707963267948966
# 10 % of X-axis
>>> unit.Percent(X_AXIS) * 10
1.4222222222222223

Contributor guide

Research direction
Examine the unit conversion implementation in PR #742 and write clear documentation explaining how to use Pixel, Degrees, and Percent units.
Tech stack
python
Domain
documentation
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.
Active
ClarityHow clearly the issue explains the expected change, acceptance criteria, and next step.
Clear
Prerequisites
Python
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
75