python / python/typeshed

Stubtest docs: common failure/suppression examples + debugging guidance

Aperta
#12,962 0 commenti 3 reazioni 0 assegnatari Vedi su GitHub

Nessuno ha ancora preso questa issue.

project: infrastructure
Lingua principale
Python
Stelle
5.1k
Fork
2.1k
Merge medio
1g 19h
PR unite (30g)
82

Descrizione

I feel like the contributing guide could benefit from instructions around debugging stubtest failures, and examples of things that stubtest can't handle that would warrant suppressions.

The mypy stubtest docs don't really go into enough detail or have enough examples, which makes it harder for new contributors (like myself) to debug failures.

Maybe we could improve that doc and link to it from CONTRIBUTING.md. I think that would reduce the need for maintainers to help stub contributors debug these failures, and make things a bit more self-service.

I'm happy to contribute to this, though I'm a bit too new to know which specific patterns are commonly suppressed.

Guida per i contributori

Apri la guida per i contributori

Come iniziare

  1. Leggi tutta la issue e poi la guida ai contributi del progetto.
  2. Commenta sulla issue per dire che te ne occupi tu — evita che due persone facciano lo stesso lavoro.
  3. Fai un fork del repository e lavora su un branch.
  4. Apri una pull request che faccia riferimento al numero della issue.

Direzione di ricerca

Inizia da CONTRIBUTING.md e dalla documentazione mypy stubtest collegata, quindi individua dove dovrebbero risiedere le indicazioni per il debugging e la soppressione degli errori di stubtest. Il lavoro è completato quando vengono aggiunti esempi di errori e soppressioni comuni, viene spiegato come eseguire il debugging degli errori e la documentazione migliorata viene collegata da CONTRIBUTING.md.

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

Valutazione

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

Ricevi le nuove issue nella tua casella

Un breve riepilogo di issue GitHub adatte ai principianti.