pypa / pypa/packaging.python.org

`test` vs. `tests`

Aperta Adatta ai principianti
#1,165 5 commenti 0 reazioni 0 assegnatari Vedi su GitHub

Nessuno ha ancora preso questa issue.

component: guides component: tutorials type: enhancement type: task
Lingua principale
Python
Stelle
1.7k
Fork
1.7k
Merge medio
3g 12h
PR unite (30g)
4

Descrizione

Should tests live in directory test or tests? The guide seems inconsistent to me, but I'm new to contemporary Python packaging, so I may have missed something.

It is test in guides/using-manifest-in.rst:

How files are included in an sdist

The following files are included in a source distribution by default:

  • ...
  • all files matching the pattern test/test*.py

and tests in tutorials/packaging-projects.rst:

Creating a test directory

tests/ is a placeholder for test files. Leave it empty for now.

Is tests always the expected name for the directory containing tests? Could/should the guide standardize on that?

Guida per i contributori

Nessuna guida per i contributori indicizzata per questo repository

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

Leggi guides/using-manifest-in.rst e tutorials/packaging-projects.rst, confrontando il modo in cui ciascuno descrive il nome della directory dei test. Controlla le indicazioni circostanti sul packaging prima di decidere se la terminologia debba essere standardizzata. Il lavoro è completo quando la documentazione fornisce indicazioni coerenti e non ambigue sulla denominazione della directory che contiene i test.

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

Valutazione

Stack tecnologico
python
Ambito
documentation
Tipo di issue
Documentazione
Difficoltà
2/5
Tempo stimato
1-3 ore
Stato di attività
Tranquilla
Chiarezza
Abbastanza chiara
Idoneità per principianti
64/100

Ricevi le nuove issue nella tua casella

Un breve riepilogo di issue GitHub adatte ai principianti.