Store function metadata in a machine readable format

オープン
#49 コメント 6 件 リアクション 5 件 担当者 0 名 GitHub で見る

まだ誰も着手していません。

評価

難易度
5/5
見積もり時間
1週間以上
初心者へのやさしさ
25/100
issue の種類
機能追加
明瞭さ
説明が足りない
活発さ
停滞
技術スタック
json, markdown, python
領域
documentation, testing, tooling

調査の方向性

まず、既存のMarkdown仕様ファイルと、テストスイートで現在行われている関数シグネチャの正規表現による解析を確認します。シグネチャ以外にどのメタデータを抽出する必要があるかを特定し、次にJSONでそれをどのように表現すべきか、関連する仕様セクションをどのように生成するかを決定します。テストスイートがMarkdownからシグネチャを解析せずに機械可読なメタデータを利用し、本文は仕様に残る状態になれば完了です。

索引モデルが issue の本文から書いたものです。

説明

Tools

It would be useful for the test suite to have the function metadata stored in a machine readable format. Currently I am parsing the function signatures from the spec files using some regular expressions, and I will probably end up parsing some other information such as types as well. This works fine for now, but it would be cleaner if this data were stored in a machine readable format, say in JSON, and the relevant parts of the spec documents generated from that automatically.

To be sure, not everything in the spec needs to be in JSON, just the parts that will need to be extracted for other things as well, such as the test suite. There should still be a lot of plain English descriptions of behavior.

This is likely too much work for version 1 given that we already have things inline in the Markdown, but it's something to consider for future iterations.

主要言語
Python
スター
281
フォーク
52
30日以内にマージされた PR はありません

コントリビューションガイド

コントリビューションガイドを開く

はじめの一歩

  1. issue を最後まで読み、次にプロジェクトのコントリビューションガイドを読みます。
  2. 着手することを issue にコメントします — 二人が同じ作業をするのを防げます。
  3. リポジトリをフォークし、ブランチを切って変更します。
  4. issue 番号を参照したプルリクエストを送ります。

data-apis/array-api のほかの issue

data-apis/array-api の issue をすべて見る

似ている issue

Python の issue をもっと見る

新しい issue をメールで受け取る

初心者向けの GitHub issue を短くまとめたダイジェスト。