reactjs / reactjs/react-docgen

Flow's @platform attribute treated as part of the description

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

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

主要言語
TypeScript
スター
3.8k
フォーク
316
平均マージ
5時間 7分
マージ済み PR(30日)
4

説明

See: React Native Button.js

/**
   * TV next focus down (see documentation for the View component).
   *
   * @platform android
   */
  nextFocusDown?: ?number,

gets captured as:

"nextFocusDown": {
        "required": false,
        "flowType": {
          "name": "number",
          "nullable": true
        },
        "description": "TV next focus down (see documentation for the View component).\n\n@platform android"

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

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

はじめの一歩

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

調査の方向性

まず React Native の Button.js の例からの抽出を再現し、次に Flow のドキュメントブロックがどのように解析されるかを追跡します。完了条件は、@platform android アノテーションがプロパティの説明に含まれなくなり、抽出された結果が意図したメタデータの動作と一致することです。

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

評価

技術スタック
react-native
領域
documentation, tooling
issue の種類
バグ
難易度
3/5
見積もり時間
1〜2日
活発さ
停滞
明瞭さ
おおむね明確
初心者へのやさしさ
35/100

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

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