pypa / pypa/packaging.python.org

Contradictions/Inconsistencies between packaging tutorial and guide

Aperta
#887 10 commenti 4 reazioni 0 assegnatari Vedi su GitHub

Nessuno ha ancora preso questa issue.

type: bug
Lingua principale
Python
Stelle
1.7k
Fork
1.7k
Merge medio
3g 12h
PR unite (30g)
4

Descrizione

Page 1: Packaging Python Projects
Page 2: Packaging and distributing projects

The first states

"setup.py # optional, needed to make editable pip installs work"

The second states

"The most important file is setup.py which exists at the root of your project directory."

The first mentions pyproject.toml, whereas the second doesn't mention it at all.

I know that one's a "tutorial" and the other is a "guide", and the website states that guides have more detailed information. In this case it appears there's some detail in the tutorial that isn't in the guide.

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

Inizia confrontando il tutorial collegato «Packaging Python Projects» e la guida «Packaging and distributing projects», concentrandoti sulle loro indicazioni riguardo a setup.py e pyproject.toml. Esamina le indicazioni circostanti sul packaging prima di decidere come allineare le pagine. Il lavoro è completato quando le due pagine spiegano questi file in modo coerente e senza indicazioni contraddittorie.

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

Valutazione

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

Ricevi le nuove issue nella tua casella

Un breve riepilogo di issue GitHub adatte ai principianti.