pypa / pypa/packaging.python.org

Document discouraged / deprecated setup arguments

Offen
#293 1 Kommentar 0 Reaktionen 0 zugewiesene Personen Auf GitHub ansehen

Dieses Issue hat noch niemand übernommen.

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

Beschreibung

We presently document an opinionated set of setup args that are applicable to most packaging scenarios. We also have additional topics for more advanced use cases. However, we don't presently document arguments that should never be used or used with extreme caution.

So far, the ones I'm aware of are:

  1. requires dates from a pre-PyPI & setuptools time and has now been replaced by install_requires.
  2. provides is unused.
  3. obsoletes is unused.
  4. platforms has ambiguous behavior.
  5. dependency_links isn't supported by pip.
  6. download_url has surprising behavior and shouldn't be used.

(Original context: #264)

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

Prüfe die vorhandene Dokumentation zu setup-Argumenten sowie den Kontext in Issue #264, bevor du entscheidest, wo diese Hinweise hingehören. Dokumentiere die Hinweise zu requires, provides, obsoletes, platforms, dependency_links und download_url; der Abschluss ist erreicht, wenn alle sechs Argumente abgedeckt sind.

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
45/100

Neue Issues direkt in Ihr Postfach

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