Go documentation is missing reference links
まだ誰も着手していません。
評価
- 難易度
- 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時間
- マージ済み PR（30日）
- 13
コントリビューションガイド
はじめの一歩
- issue を最後まで読み、次にプロジェクトのコントリビューションガイドを読みます。
- 着手することを issue にコメントします — 二人が同じ作業をするのを防げます。
- リポジトリをフォークし、ブランチを切って変更します。
- issue 番号を参照したプルリクエストを送ります。
freeCodeCamp/devdocs のほかの issue
-
docs/improvement
難易度 2/5 1〜3時間 初心者へのやさしさ 62/100
freeCodeCamp/devdocs#1989 · コメント 4 件 · リアクション 4 件 ·
-
難易度 5/5 1週間以上 初心者へのやさしさ 20/100
freeCodeCamp/devdocs#2731 ·
-
feature
難易度 5/5 1週間以上 初心者へのやさしさ 25/100
freeCodeCamp/devdocs#2712 ·
-
feature
難易度 5/5 1週間以上 初心者へのやさしさ 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 ·