[API Docs inaccuracy] <Get a Commit Comment>
まだ誰も着手していません。
評価
- 難易度
- 2/5
- 見積もり時間
- 1〜3時間
- 初心者へのやさしさ
- 68/100
- issue の種類
- ドキュメント
- 明瞭さ
- おおむね明確
- 活発さ
- 静か
- 技術スタック
- openapi
- 領域
- api, documentation
調査の方向性
リンクされている Get a Commit Comment エンドポイントの REST API ドキュメントから始め、そのレスポンス例を issue にある inline コメントと通常のコメントの例と比較してください。API の説明を更新し、両方のコメント形式を記載してください。inline コメントでは数値の line を、通常のコメントでは null を含めます。
索引モデルが issue の本文から書いたものです。
説明
API Docs Inaccuracy
Description
Referring to REST API documentation for GitHub commit comments
There are two types of commit comments, inline and regular.
Inline comment html_url format: {owner}/{repo}/commit/{commit sha}#r{id}
Inline comments also have "line":{number} as part of the API response
Example inline comment: https://github.com/octocat/Hello-World/commit/553c2077f0edc3d5dc5d17262f6aa498e69d6f8e#r3291273
Regular comment html_url format: {owner}/{repo}/commit/{commit sha}#commitcomment-{id}
Regular comments also have "line": null as part of the API response (since they are not attached to any line of code)
Example regular comment: https://github.com/octocat/Hello-World/commit/553c2077f0edc3d5dc5d17262f6aa498e69d6f8e#commitcomment-292400
This differs from the format shows in the api docs: Get a commit comment
Only regular comments are documented and it lists a nonnull line number, which is only found in inline comments
Expected
Can we have both versions of commit comments documented? (Inline and regular)
The example regular comment should display a null value for line while the inline comment displays a value for line
- 主要言語
- 言語のデータがありません
- スター
- 1.6k
- フォーク
- 342
- 平均マージ
- 2時間 23分
- マージ済み PR（30日）
- 57
コントリビューションガイド
はじめの一歩
- issue を最後まで読み、次にプロジェクトのコントリビューションガイドを読みます。
- 着手することを issue にコメントします — 二人が同じ作業をするのを防げます。
- リポジトリをフォークし、ブランチを切って変更します。
- issue 番号を参照したプルリクエストを送ります。
github/rest-api-description のほかの issue
-
feature
難易度 2/5 1〜3時間 初心者へのやさしさ 85/100
github/rest-api-description#7220 ·
-
feature
難易度 2/5 1〜3時間 初心者へのやさしさ 82/100
github/rest-api-description#7201 ·
-
feature
難易度 2/5 1〜3時間 初心者へのやさしさ 72/100
github/rest-api-description#7163 ·
-
feature
難易度 2/5 1〜3時間 初心者へのやさしさ 68/100
github/rest-api-description#7162 ·
-
feature
難易度 2/5 1〜3時間 初心者へのやさしさ 68/100
github/rest-api-description#7135 ·
github/rest-api-description の issue をすべて見る
似ている issue
-
enhancement
難易度 2/5 1〜3時間 初心者へのやさしさ 70/100
canonical/paas-charm#368 · コメント 1 件 ·
-
難易度 2/5 1〜3時間 初心者へのやさしさ 75/100
-
tech debt
難易度 2/5 1〜3時間 初心者へのやさしさ 75/100
-
area:workflow bug ready-for-agent
難易度 2/5 1〜3時間 初心者へのやさしさ 75/100
fil-donadoni/tolaria#4409 ·
-
status/awaiting_triage
難易度 2/5 1〜3時間 初心者へのやさしさ 75/100