ManimCommunity/manim

Add documentation about unit conversion feature

Open

#2512 opened on Jan 29, 2022

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

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

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.
under 1 hour
Activity statusHow available the issue appears right now: fresh, active, stale, blocked, or waiting on maintainer input.
blocked
ClarityHow clearly the issue explains the expected change, acceptance criteria, and next step.
clear
Prerequisites
Python basicsFamiliarity with manim
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
50
Research direction
Review the implementation in PR #742 to understand the unit conversion feature. Look at the existing documentation structure in the 'docs/' directory to determine the appropriate placement. The issue provides example code that should be incorporated into the documentation, and you may need to explain the unit types (Pixels, Degrees, Percent) in context. Check if the assignee has made progress, as the issue is already assigned.