react-navigation / react-navigation/react-navigation.github.io

Better documentation for router getScreenOptions

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

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

help wanted
主要言語
JavaScript
スター
324
フォーク
2k
PR マージ指標
30日以内にマージされた PR はありません

説明

The documentation of getScreenOptions needs some clarification:

  • the headline is getScreenOptions(navigation, screenProps) but the text explains 3 parameters. What is about navigationOptions?
  • The text says "retrieve the navigation options for a screen". Why the function is named screen options while it returns navigation options?
  • The example code uses addNavigationHelpers which does not exits anymore?
  • For me is not clear where I can use this function, p.ex. in screen, in my custom router, etc. Please improve the example to make this more clear.

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

このリポジトリのコントリビューションガイドは索引されていません

はじめの一歩

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

調査の方向性

リンクされている custom-routers のドキュメントの getScreenOptions セクションから始め、そのシグネチャ、説明、addNavigationHelpers を使用した例を確認してください。パラメーター、用語、現在の API の使用方法、およびその関数がどこで使用されているかを明確にします。例と周辺のテキストだけで各項目に答えられ、古い API に依存していなければ完了です。

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

評価

技術スタック
javascript, react-native
領域
documentation
issue の種類
ドキュメント
難易度
2/5
見積もり時間
1〜3時間
活発さ
停滞
明瞭さ
おおむね明確
初心者へのやさしさ
45/100

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

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