Proposal to change state hook documentation
オープン
まだ誰も着手していません。
- 主要言語
- JavaScript
- スター
- 11.8k
- フォーク
- 7.9k
- 平均マージ
- 1日 11時間
- マージ済み PR(30日)
- 11
説明
The current documentation for setting state hooks is shown as:
<button onClick={() => setCount(count + 1)}>
However wouldn't it be much better to use the previous state?
<button onClick={() => setCount(prevCount => prevCount + 1)}>
This would be more consistent with the original setState documentation.
I have also personally had issues with states being handled incorrectly due to using the documented method of setting state with the rendered state.
Wouldn't this prevent a lot of logical errors people may face due to the documentation?
コントリビューションガイド
はじめの一歩
- issue を最後まで読み、次にプロジェクトのコントリビューションガイドを読みます。
- 着手することを issue にコメントします — 二人が同じ作業をするのを防げます。
- リポジトリをフォークし、ブランチを切って変更します。
- issue 番号を参照したプルリクエストを送ります。
調査の方向性
リンクされているHooksの導入ドキュメントから始め、その状態設定の例を、リンクされている元のsetStateドキュメントと比較します。関数型更新と既存のドキュメントとの一貫性に対応するよう、例または付随するガイダンスを更新します。改訂された例が意図された状態更新パターンを明確に伝えれば完了です。
索引モデルが issue の本文から書いたものです。
評価
- 技術スタック
- javascript, react
- 領域
- documentation
- issue の種類
- ドキュメント
- 難易度
- 2/5
- 見積もり時間
- 1〜3時間
- 活発さ
- 停滞
- 明瞭さ
- 明確に書かれている
- 初心者へのやさしさ
- 55/100