pypa / pypa/packaging.python.org
Document warnings on how to set (long_)description
Nessuno ha ancora preso questa issue.
- Lingua principale
- Python
- Stelle
- 1.7k
- Fork
- 1.7k
- Merge medio
- 3g 12h
- PR unite (30g)
- 4
Descrizione
I have just spent >= 1 hour to overcome this bug: https://github.com/pypa/twine/issues/454
- In the
descriptionargument passed tosetup(...), you must not pass newlines!
(Especially I passed__doc__, which starts of course with a newline most of the time.) - In the
long_descriptionargument passed tosetup(...), 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/.
Guida per i contributori
Nessuna guida per i contributori indicizzata per questo repository
Come iniziare
- Leggi tutta la issue e poi la guida ai contributi del progetto.
- Commenta sulla issue per dire che te ne occupi tu — evita che due persone facciano lo stesso lavoro.
- Fai un fork del repository e lavora su un branch.
- Apri una pull request che faccia riferimento al numero della issue.
Direzione di ricerca
Inizia dal tutorial di packaging-projects indicato nell’issue e verifica l’issue di Twine collegata per il comportamento segnalato. Il lavoro è completato quando il tutorial documenta i requisiti relativi ai caratteri di nuova riga di description e long_description e include indicazioni per impostare long_description_content_type.
Scritto dal modello di indicizzazione a partire dal testo della issue.
Valutazione
- Stack tecnologico
- python
- Ambito
- documentation
- Tipo di issue
- Documentazione
- Difficoltà
- 2/5
- Tempo stimato
- 1-3 ore
- Stato di attività
- Ferma
- Chiarezza
- Abbastanza chiara
- Idoneità per principianti
- 45/100