Go documentation is missing reference links
还没有人认领这个 Issue。
评估
- 难度
- 3/5
- 预计耗时
- 1-2 天
- 新手友好度
- 40/100
- Issue 类型
- 缺陷
- 描述清晰度
- 基本清楚
- 活跃度
- 停滞
- 技术栈
- go
调研方向
将 devdocs.io 上的 net/http Client.Do 页面与链接的 pkg.go.dev 参考文档进行比较，以识别缺失的源代码链接和输入/输出链接。然后定位 Go 文档生成入口及其相关测试；当生成的 Go 参考标头能够一致地公开预期链接时，即视为完成。
由索引模型根据 Issue 内容生成。
描述
Documentation style bug: Go documentation missing reference links
Summary
devdocs.io is missing useful links in Go reference documentation that are very handy when working with package API:
- links to the Go source code implementation for the code
- links to input/output structures
I'm happy to contribute a fix if this is a bug rather than a deliberate choice.
Actual style
See https://devdocs.io/go/net/http/index#Client.Do and how the header does not have links:
Expected style
Official documentation that has links in the header: https://pkg.go.dev/net/http#Client.Do
- 主要语言
- Ruby
- 星标
- 39.5k
- 派生
- 2.6k
- 平均合并
- 2 天 9 小时
- 30 天内合并 PR
- 13
贡献指南
从这里开始
- 先读完整个 Issue，再读项目的贡献指南。
- 在 Issue 下留言说明你要接手 —— 这能避免两个人做同样的事。
- Fork 仓库，在一个分支上完成修改。
- 提交 Pull Request，并在描述里引用这个 Issue 编号。
freeCodeCamp/devdocs 的其他 Issue
-
docs/improvement
难度 2/5 1-3 小时 新手友好度 62/100
freeCodeCamp/devdocs#1989 · 4 条评论 · 4 个 reaction ·
-
难度 5/5 一周以上 新手友好度 20/100
freeCodeCamp/devdocs#2731 ·
-
feature
难度 5/5 一周以上 新手友好度 25/100
freeCodeCamp/devdocs#2712 ·
-
feature
难度 5/5 一周以上 新手友好度 30/100
freeCodeCamp/devdocs#2683 · 1 条评论 ·
-
feature
难度 4/5 3-5 天 新手友好度 45/100
freeCodeCamp/devdocs#2673 ·
查看 freeCodeCamp/devdocs 的全部 Issue
相似的 Issue
-
难度 2/5 1-3 小时 新手友好度 70/100
-
bug
难度 1/5 1 小时以内 新手友好度 90/100
riscv/riscv-unified-db#2626 ·
-
Component: GLib
难度 2/5 1-3 小时 新手友好度 70/100
-
ds-drift
难度 2/5 1-3 小时 新手友好度 70/100
we-promise/sure#3693 ·
-
难度 2/5 1-3 小时 新手友好度 75/100
simp/pupmod-simp-simp#395 ·