[API Docs inaccuracy] <Get a Commit Comment>
Nessuno ha ancora preso questa issue.
Valutazione
- Difficoltà
- 2/5
- Tempo stimato
- 1-3 ore
- Idoneità per principianti
- 68/100
- Tipo di issue
- Documentazione
- Chiarezza
- Abbastanza chiara
- Stato di attività
- Tranquilla
- Stack tecnologico
- openapi
- Ambito
- api, documentation
Direzione di ricerca
Inizia dalla documentazione REST API collegata per l'endpoint Get a Commit Comment e confronta il relativo esempio di risposta con gli esempi di commenti inline e normali nell'issue. Aggiorna la descrizione dell'API in modo da documentare entrambe le forme di commento, includendo una linea numerica per i commenti inline e null per i commenti normali.
Scritto dal modello di indicizzazione a partire dal testo della issue.
Descrizione
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
- Lingua principale
- Nessun dato sulla lingua
- Stelle
- 1.6k
- Fork
- 342
- Merge medio
- 3h 33m
- PR unite (30g)
- 51
Guida per i contributori
Apri la guida per i contributori
Come iniziare
- Leggi tutta la issue e poi la guida ai contributi del progetto.
- Commenta sulla issue per dire che te ne occupi tu — evita che due persone facciano lo stesso lavoro.
- Fai un fork del repository e lavora su un branch.
- Apri una pull request che faccia riferimento al numero della issue.
Altre issue di github/rest-api-description
-
feature
Difficoltà 2/5 1-3 ore Idoneità per principianti 82/100
github/rest-api-description#7201 ·
-
feature
Difficoltà 2/5 1-3 ore Idoneità per principianti 72/100
github/rest-api-description#7163 ·
-
Runner deprecations: registration_deprecates_at is declared on the response but never returned Apertafeature
Difficoltà 2/5 1-3 ore Idoneità per principianti 68/100
github/rest-api-description#7162 ·
-
feature
Difficoltà 2/5 1-3 ore Idoneità per principianti 68/100
github/rest-api-description#7135 ·
-
feature
Difficoltà 2/5 1-3 ore Idoneità per principianti 74/100
github/rest-api-description#7111 · 1 commento ·
Tutte le issue di github/rest-api-description
Issue simili
-
Difficoltà 2/5 1-3 ore Idoneità per principianti 78/100
use-agent-os/agent-os#3312 ·
-
Difficoltà 2/5 1-3 ore Idoneità per principianti 85/100
-
needs-acceptance wg/data-plane-networking
Difficoltà 2/5 1-3 ore Idoneità per principianti 78/100
vllm-project/semantic-router#4024 · 1 commento ·
-
bug good first issue
Difficoltà 2/5 1-3 ore Idoneità per principianti 88/100
amponce/archive-movie-browser#165 ·
-
Difficoltà 2/5 1-3 ore Idoneità per principianti 78/100