python / python/typing_extensions

Future of typing_extensions.Doc

Ouverte
#443 10 commentaires 5 réactions 0 personnes assignées Voir sur GitHub

Personne n'a encore pris cette issue.

Langage dominant
Python
Étoiles
583
Forks
146
Merge moyen
10 h 11 min
PR mergées (30 j)
5

Description

PEP-727 proposed a new Doc construct, but the PEP is unlikely to be accepted and will probably be withdrawn (https://discuss.python.org/t/pep-727-documentation-metadata-in-typing/32566/181).

That makes it so we have to figure out what to do with typing_extensions.Doc in the future. We don't have any previous cases where a feature was proposed in a PEP that didn't get accepted. We do have the precedent of typing_extensions.IntVar, which was added a long time ago without ever being proposed in a PEP. It is still in typing_extensions but undocumented.

I'm hesitant to remove importable objects from typing_extensions, because this library is so widely used and is a dependency of many other important libraries. If we remove something, we could end up breaking an important third-party library. Libraries could also end up pinning the version of typing-extensions they depend on, which is disruptive because it restricts users using that library from using new features of newer versions of typing-extensions.

Doc is also quite simple (a single class of a few dozen lines; no interaction with other features). Therefore, I don't see a big problem with keeping it around. However, we should mark it as deprecated in the documentation and probably move it into its own section.

Guide de contribution

Ouvrir le guide de contribution

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

Commencez par examiner la documentation actuelle de typing_extensions.Doc et la discussion liée dans l’issue, puis comparez le traitement de IntVar. L’issue est terminée lorsque le projet a décidé comment Doc doit être traité et que la documentation reflète cette décision, y compris la dépréciation et l’emplacement de la section si cela est adopté.

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é
4/5
Temps estimé
3-5 jours
Activité
À l'abandon
Clarté
Plutôt claire
Accessibilité débutants
30/100

Recevez les nouvelles issues par e-mail

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