pypa / pypa/packaging.python.org

Contradictions/Inconsistencies between packaging tutorial and guide

Offen
#887 10 Kommentare 4 Reaktionen 0 zugewiesene Personen Auf GitHub ansehen

Dieses Issue hat noch niemand übernommen.

type: bug
Vorherrschende Sprache
Python
Sterne
1.7k
Forks
1.7k
Ø Merge
3 T. 12 Std.
Gemergte PRs (30 T.)
4

Beschreibung

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.

Beitragsleitfaden

Für dieses Repository ist kein Beitragsleitfaden indexiert

Erste Schritte

  1. Lies das ganze Issue und danach den Beitragsleitfaden des Projekts.
  2. Schreib ins Issue, dass du es übernimmst — das erspart doppelte Arbeit.
  3. Forke das Repository und arbeite in einem Branch.
  4. Öffne einen Pull Request, der die Issue-Nummer nennt.

Rechercherichtung

Beginne damit, das verlinkte Tutorial „Packaging Python Projects“ und den Leitfaden „Packaging and distributing projects“ zu vergleichen, wobei du dich auf deren Aussagen zu setup.py und pyproject.toml konzentrierst. Prüfe die umgebenden Hinweise zum Packaging, bevor du entscheidest, wie die Seiten aufeinander abgestimmt werden sollten. Als abgeschlossen gilt die Aufgabe, wenn beide Seiten diese Dateien konsistent und ohne widersprüchliche Hinweise erklären.

Vom Indexierungsmodell aus dem Issue-Text verfasst.

Bewertung

Tech-Stack
python
Bereich
documentation
Issue-Typ
Dokumentation
Schwierigkeit
3/5
Geschätzter Aufwand
1-2 Tage
Aktivitätsstatus
Veraltet
Klarheit
Größtenteils klar
Anfängerfreundlichkeit
35/100

Neue Issues direkt in Ihr Postfach

Eine kurze Übersicht über anfängerfreundliche GitHub-Issues.