pypa / pypa/packaging.python.org

Document warnings on how to set (long_)description

Offen
#645 0 Kommentare 0 Reaktionen 0 zugewiesene Personen Auf GitHub ansehen

Dieses Issue hat noch niemand übernommen.

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

Beschreibung

I have just spent >= 1 hour to overcome this bug: https://github.com/pypa/twine/issues/454

  • In the description argument passed to setup(...), you must not pass newlines!

    (Especially I passed __doc__, which starts of course with a newline most of the time.)
  • In the long_description argument passed to setup(...), you must use LF newlines (\n) exclusively. (No \n! No \r!)

    I suggest doing
    # Open readme with original (i.e. LF) newlines
    # to prevent the all too common "`long_description_content_type` missing"
    # bug (https://github.com/pypa/twine/issues/454)
    with open('README.md', 'r', newline='', encoding='utf-8') as readme_file:
    	long_description = readme_file.read()
    	long_description_content_type = 'text/markdown'
    
    setup(
    	# ...
    	long_description = long_description,
    	long_description_content_type = long_description_content_type,
    )
    

This should be documented in https://packaging.python.org/tutorials/packaging-projects/.

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

Beginnen Sie mit dem im Issue genannten Tutorial von packaging-projects und prüfen Sie das verlinkte Twine-Issue auf das gemeldete Verhalten. Als erledigt gilt die Aufgabe, wenn das Tutorial die Anforderungen an Zeilenumbrüche für description und long_description dokumentiert und Anleitungen zum Setzen von long_description_content_type enthält.

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
Größtenteils klar
Anfängerfreundlichkeit
45/100

Neue Issues direkt in Ihr Postfach

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