AnswerDotAI / AnswerDotAI/ghapi

Document leaky exceptions

Aperta
#164 0 commenti 1 reazione 0 assegnatari Vedi su GitHub
Lingua principale
Python
Stelle
686
Fork
69
Merge medio
1m
PR unite (30g)
2

Descrizione

Documentation does not appear to mention exceptions. Experimentally, this appears to raise `fastcore.net` HTTP exceptions, which unfortunately leaks that abstraction; ideally I think the API would raise its own `GhApi` exceptions.

In either case though, users should be able to read the docs to see what exceptions they should handle.

Guida per i contributori

Apri la guida per i contributori

Direzione di ricerca

Inizia leggendo la documentazione del client API e riproduci il comportamento delle eccezioni attribuito a fastcore.net. Documenta quali eccezioni gli utenti devono gestire, chiarendo se il comportamento attuale di GhApi o un design separato delle eccezioni rientra nell’ambito; il lavoro è completo quando la gestione delle eccezioni supportata è esplicitamente descritta nella documentazione.

Scritto dal modello di indicizzazione a partire dal testo della issue.

Valutazione

Stack tecnologico
python
Ambito
api, documentation
Tipo di issue
Documentazione
Difficoltà
3/5
Tempo stimato
1-2 giorni
Stato di attività
Ferma
Chiarezza
Abbastanza chiara
Idoneità per principianti
42/100

Ricevi le nuove issue nella tua casella

Un breve riepilogo di issue GitHub adatte ai principianti.