pypa / pypa/packaging.python.org

Document discouraged / deprecated setup arguments

Ouverte
#293 1 commentaire 0 réactions 0 personnes assignées Voir sur GitHub

Personne n'a encore pris cette issue.

type: enhancement
Langage dominant
Python
Étoiles
1.7k
Forks
1.7k
Merge moyen
3 j 12 h
PR mergées (30 j)
4

Description

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)

Guide de contribution

Aucun guide de contribution indexé pour ce dépôt

Par où commencer

  1. Lisez l'issue en entier, puis le guide de contribution du projet.
  2. Signalez en commentaire que vous la prenez — cela évite que deux personnes fassent le même travail.
  3. Forkez le dépôt et travaillez sur une branche.
  4. Ouvrez une pull request qui référence le numéro de l'issue.

Piste de recherche

Examinez la documentation existante sur les arguments de setup ainsi que le contexte de l’issue #264 avant de décider où ces notes doivent être placées. Documentez les précautions concernant requires, provides, obsoletes, platforms, dependency_links et download_url, en considérant le travail terminé lorsque les six arguments sont couverts.

Rédigé par le modèle d'indexation à partir du texte de l'issue.

Évaluation

Stack technique
python
Domaine
documentation
Type d'issue
Documentation
Difficulté
2/5
Temps estimé
1-3 heures
Activité
À l'abandon
Clarté
Clairement spécifiée
Accessibilité débutants
45/100

Recevez les nouvelles issues par e-mail

Un résumé court des issues GitHub adaptées aux débutants.