Improve documentation for IsSymbol
还没有人认领这个 Issue。
评估
- 难度
- 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 小时
- 30 天内合并 PR
- 1
环境准备
- 没有 Dockerfile 或 Docker Compose 文件
- 有 Pull Request 模板
- 没有贡献指南
从这里开始
- 先读完整个 Issue，再读项目的贡献指南。
- 在 Issue 下留言说明你要接手 —— 这能避免两个人做同样的事。
- Fork 仓库，在一个分支上完成修改。
- 提交 Pull Request，并在描述里引用这个 Issue 编号。
purescript/purescript-prelude 的其他 Issue
-
难度 2/5 1-3 小时 新手友好度 57/100
purescript/purescript-prelude#317 · 1 个 reaction ·
-
难度 3/5 1-2 天 新手友好度 32/100
purescript/purescript-prelude#312 · 5 条评论 ·
-
难度 5/5 一周以上 新手友好度 25/100
purescript/purescript-prelude#310 · 5 条评论 ·
-
难度 5/5 一周以上 新手友好度 24/100
purescript/purescript-prelude#308 · 2 条评论 ·
-
难度 3/5 1-2 天 新手友好度 35/100
purescript/purescript-prelude#307 · 1 条评论 · 1 个 reaction ·
查看 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 天内回复