Clarifying documentation of typing.Set
Personne n'a encore pris cette issue.
- Langage dominant
- Python
- Étoiles
- 77.2k
- Forks
- 36k
- Métriques de merge des PR
- Métriques de PR en attente
Description
Documentation
Edit: I added some more clarification.
Documentation of typing.Set is not entirely clear
The typing module's documentation currently requires two hops when the reader looks up typing.Set.
- In the docstring of
typing.Setit states "To annotate arguments it is preferred to use an abstract collection type such as AbstractSet." This is referring totyping.AbstractSet - Docstring of
typing.AbstractSetsays that it is deprecated and refers the reader tocollections.abc.Set, which has no docstring of its own (it is grouped together with the docstring ofcollections.abc.MutableSet.
I feel we can prevent these two hops i.e.typing.Set --> typing.AbstractSet --> collections.abc.Setand direct the reader to the final destination i.e.typing.Set -> collections.abc.Set.
Suggested change
typing.Setshould say something like --
"To annotate arguments it is preferred to use an abstract collection type such as
collections.abc.Set.
"To annotate everything else, the use oftyping.Setis deprecated since version 3.9:builtins.setnow supports[]. SeePEP 585andGeneric Alias Type"
- Docstring of
typing.AbstractSetis fine as it is. collections.abc.Setshould say something like --
"Use this to annotate arguments. For all other annotations, use
builtins.set, which now supported[]. SeePEP 585...
Other generic alias types like List, Tuple, FrozenSet etc. probably could use a similar change (IF others agree that this is something that needs to changed at all.)
Guide de contribution
Ouvrir le guide de contribution
Par où commencer
- Lisez l'issue en entier, puis le guide de contribution du projet.
- Signalez en commentaire que vous la prenez — cela évite que deux personnes fassent le même travail.
- Forkez le dépôt et travaillez sur une branche.
- Ouvrez une pull request qui référence le numéro de l'issue.
Piste de recherche
Commencez par les docstrings de typing.Set et collections.abc.Set, puis comparez la documentation correspondante sur les alias génériques et les recommandations de PEP 585. Le travail est terminé lorsque la documentation dirige les lecteurs de typing.Set vers collections.abc.Set sans l’étape intermédiaire supplémentaire et explique clairement quand utiliser builtins.set.
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é
- Plutôt claire
- Accessibilité débutants
- 35/100