ManimCommunity/manim

Add documentation about unit conversion feature

Open

#2,512 opened on 2022年1月29日

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

説明

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

コントリビューターガイド

技術スタック
python
領域
documentation
Issue 種別
documentation
難度新しい貢献者にとっての実装難度です。1 は非常に小さな変更、5 は専門的な作業です。
2
推定時間経験ある貢献者が調査、実装、テスト、pull request 準備にかけるおおよその時間範囲です。
under 1 hour
活動状況Issue が今どれだけ取り組みやすいかを示します。新しい、活発、古い、ブロック中、またはメンテナー入力待ちなどです。
blocked
明確さ期待される変更、受け入れ条件、次の手順がどれだけ明確かを示します。
clear
前提条件
Python basicsFamiliarity with manim
初心者向け度初回貢献者にどれだけ取り組みやすいかを 1-100 で推定したスコアです。
50
調査方針
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.