pypa / pypa/packaging.python.org

New tutorials: write section to define and describe "package"

Offen
#199 7 Kommentare 0 Reaktionen 0 zugewiesene Personen Auf GitHub ansehen

Dieses Issue hat noch niemand übernommen.

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

Beschreibung

(For more information about this issue, please see #194).

We need a short section to follow the prerequisites section (see #196) (i.e., as its own file). It should satisfy the following goals:

  • explain what a distribution package is
  • explain how a distribution package differs from import packages and modules
  • use the terminology that the wider Python Packaging User Guide uses, so the terminology is familiar if the reader turns to another part of the guide

I also think it would be helpful if the section could illustrate each point with some kind of example, either a made-up example or a real-world example, if it's not too complicated.

When opening pull requests for this issue, please submit to the develop branch. If you have questions that concern contributing more generally, please use issue #194. Otherwise, feel free to comment with questions or feedback. Thanks!

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, den im Issue referenzierten Abschnitt zu den Voraussetzungen und die verlinkten Glossareinträge im Python Packaging User Guide zu distribution packages, import packages und modules zu prüfen. Die Arbeit ist abgeschlossen, wenn eine eigenständige Abschnittsdatei auf den Abschnitt zu den Voraussetzungen folgt, die Terminologie des Guides verwendet und klare Beispiele enthält, die die einzelnen Konzepte voneinander unterscheiden; reiche die Änderungen in den develop branch ein.

Vom Indexierungsmodell aus dem Issue-Text verfasst.

Bewertung

Tech-Stack
python
Bereich
documentation
Issue-Typ
Dokumentation
Schwierigkeit
2/5
Geschätzter Aufwand
1-3 Stunden
Aktivitätsstatus
Veraltet
Klarheit
Klar beschrieben
Anfängerfreundlichkeit
48/100

Neue Issues direkt in Ihr Postfach

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