Migrate documentation of special cases to use math directives
まだ誰も着手していません。
評価
- 難易度
- 5/5
- 見積もり時間
- 1週間以上
- 初心者へのやさしさ
- 25/100
- issue の種類
- ドキュメント
- 明瞭さ
- 説明が足りない
- 活発さ
- 停滞
- 領域
- documentation, testing
調査の方向性
まず、API ドキュメントの特殊ケースの説明と、物語形式のコンテンツから特殊な値と期待される結果を抽出する array API テストスイートのロジックを見つけます。ドキュメント形式で math directives がどのようにサポートされているかを確認し、スイートが移行されたケースをどのように利用できるかを判断します。特殊ケースが math directives 付きでレンダリングされ、テストの抽出を壊さなければ完了です。構造化データは任意の設計上の検討事項です。
索引モデルが issue の本文から書いたものです。
説明
The documentation of special cases in API documentation predates the specification's embrace of reST and GitHub support for mathematical equations in Markdown. As such, special cases use code blocks for numerical values and mathematical symbols. We should migrate to using math directives for better and more succinct rendering.
Adoption of math directives needs to be coordinated with the array API test suite, which, TMK, relies on special cases being described in a particular format within narrative content. Migration to math directives would thus break the test suite's current parsing logic for extracting special values and the associated expected result.
During this migration, we may want to consider providing structured data (e.g., as JSON) describing special cases which can be more readily consumed by downstream consumers, such as the array API test suite, and prevent implicit dependencies on how narrative content is written.
- 主要言語
- Python
- スター
- 281
- フォーク
- 52
- PR マージ指標
- 30日以内にマージされた PR はありません
環境構築
はじめの一歩
- issue を最後まで読み、次にプロジェクトのコントリビューションガイドを読みます。
- 着手することを issue にコメントします — 二人が同じ作業をするのを防げます。
- リポジトリをフォークし、ブランチを切って変更します。
- issue 番号を参照したプルリクエストを送ります。
data-apis/array-api のほかの issue
-
bug Maintenance Narrative Content
難易度 1/5 1〜3時間 初心者へのやさしさ 88/100
-
難易度 2/5 1〜3時間 初心者へのやさしさ 70/100
-
難易度 5/5 1週間以上 初心者へのやさしさ 35/100
-
Maintenance
-
難易度 5/5 1週間以上 初心者へのやさしさ 25/100
data-apis/array-api の issue をすべて見る
似ている issue
-
bug status/needs-triage
難易度 2/5 1〜3時間 初心者へのやさしさ 86/100
prowler-cloud/prowler#12887 · コメント 1 件 ·
メンテナーはふだん 1 日以内に返信
-
area: desktop platform: macos priority: p3 status: ready type: enhancement
難易度 1/5 1時間未満 初心者へのやさしさ 92/100
use-agent-os/agent-os#3484 ·
メンテナーはふだん 2 日以内に返信
-
bug
難易度 2/5 1〜3時間 初心者へのやさしさ 86/100
open-telemetry/opentelemetry-python-contrib#5113 · コメント 2 件 · リアクション 2 件 ·
メンテナーはふだん 1 日以内に返信
-
external
難易度 2/5 1〜3時間 初心者へのやさしさ 68/100
langchain-ai/docs#6255 ·
メンテナーはふだん 1 日以内に返信
-
難易度 2/5 1〜3時間 初心者へのやさしさ 72/100
メンテナーはふだん 1 日以内に返信