Docstring of array.array misses 'w' type info and mentions wide/narrow builds
Personne n'a encore pris cette issue.
- Langage dominant
- Python
- Étoiles
- 77.2k
- Forks
- 35.9k
- Métriques de merge des PR
- Métriques de PR en attente
Description
Documentation
The docstring of array.array at https://github.com/python/cpython/blob/cfcd52490d6531f3b0e8ddd4bb2b40fb6baee854/Modules/arraymodule.c#L2912 has a few mistakes:
- in description of 'u' type it mentions the narrow/wide build split that is not a thing since 3.3 - https://docs.python.org/3/whatsnew/3.3.html#functionality
- it doesn't mention that since 3.3 the 'u' type is deprecated and 'w' should be used.
- it doesn't mention that 'u' type since 3.9 corresponds to
wchar_tof C compiler used (so usually 2 byte UTF-16 on Windows, 4 byte UTF-32 elsewhere), instead of to narrow/wide Python build. - it doesn't mention the newer 'w' type that is Python's own
Py_UCS44 byte UTF-32.
The documentation at https://docs.python.org/3/library/array.html doesn't have these issues, only the docstring (that is shown in help(array.array) in the REPL) does. This is a mismatch between documentation and docstring.
Linked PRs
- gh-142323
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 dans Modules/arraymodule.c, autour de la docstring de array.array référencée par l’issue, puis comparez-la avec la documentation de array à l’adresse docs.python.org/3/library/array.html. Le travail est terminé lorsque la docstring couvre les informations actuelles sur les types 'u' et 'w', sans l’ancienne formulation concernant les builds narrow/wide ; consultez le PR lié gh-142323 avant de commencer.
Rédigé par le modèle d'indexation à partir du texte de l'issue.
Évaluation
- Stack technique
- c, python
- Domaine
- documentation
- Type d'issue
- Documentation
- Difficulté
- 1/5
- Temps estimé
- Moins d'une heure
- Activité
- À l'abandon
- Clarté
- Clairement spécifiée
- Accessibilité débutants
- 30/100