Improve documentation for IsSymbol
まだ誰も着手していません。
評価
- 難易度
- 1/5
- 見積もり時間
- 1時間未満
- 初心者へのやさしさ
- 38/100
- issue の種類
- ドキュメント
- 明瞭さ
- 明確に書かれている
- 活発さ
- 停滞
調査の方向性
Read the IsSymbol declaration and its comments at src/Data/Symbol.purs lines 11–13. Clarify what a “known symbol” means and explain that the compiler creates these instances. Done means newcomers can understand both points from the documentation.
索引モデルが issue の本文から書いたものです。
説明
https://github.com/purescript/purescript-prelude/blob/2b47992ab8c90db27cfc77b4f1b6e500ac2321e3/src/Data/Symbol.purs#L11-L13
As a newcomer who is currently trying to learn this, I don't understand what this is supposed to mean. What is a "known symbol"? I think better documentation would explicitly mention how the compiler will create these instances for you.
- 主要言語
- PureScript
- スター
- 168
- フォーク
- 90
- 平均マージ
- 3日 1時間
- マージ済み PR（30日）
- 1
環境構築
- Dockerfile・Docker Compose ファイルなし
- プルリクエストのテンプレートあり
- コントリビューションガイドなし
はじめの一歩
- issue を最後まで読み、次にプロジェクトのコントリビューションガイドを読みます。
- 着手することを issue にコメントします — 二人が同じ作業をするのを防げます。
- リポジトリをフォークし、ブランチを切って変更します。
- issue 番号を参照したプルリクエストを送ります。
purescript/purescript-prelude のほかの issue
-
難易度 2/5 1〜3時間 初心者へのやさしさ 57/100
purescript/purescript-prelude#317 · リアクション 1 件 ·
-
難易度 3/5 1〜2日 初心者へのやさしさ 32/100
purescript/purescript-prelude#312 · コメント 5 件 ·
-
難易度 5/5 1週間以上 初心者へのやさしさ 25/100
purescript/purescript-prelude#310 · コメント 5 件 ·
-
難易度 5/5 1週間以上 初心者へのやさしさ 24/100
purescript/purescript-prelude#308 · コメント 2 件 ·
-
難易度 3/5 1〜2日 初心者へのやさしさ 35/100
purescript/purescript-prelude#307 · コメント 1 件 · リアクション 1 件 ·
purescript/purescript-prelude の issue をすべて見る
似ている issue
-
1.3 documentation
難易度 1/5 1〜3時間 初心者へのやさしさ 78/100
-
documentation Needs Human Review
難易度 2/5 1〜3時間 初心者へのやさしさ 72/100
NQCD/NQCDynamics.jl#526 ·
-
bug
難易度 1/5 1時間未満 初心者へのやさしさ 75/100
MetrolistGroup/Metrolist#4554 ·
メンテナーはふだん 1 日以内に返信
-
intake mcp-intake needs-human-review priority:high type:bug
難易度 2/5 1〜3時間 初心者へのやさしさ 66/100
Ikalus1988/MisakaNet#4903 · コメント 2 件 ·
メンテナーはふだん 1 日以内に返信
-
bug
難易度 2/5 1〜3時間 初心者へのやさしさ 82/100
メンテナーはふだん 1 日以内に返信