Document `re.Scanner`
Personne n'a encore pris cette issue.
Évaluation
- Difficulté
- 2/5
- Temps estimé
- 1-3 heures
- Accessibilité débutants
- 74/100
- Type d'issue
- Documentation
- Clarté
- Plutôt claire
- Activité
- Active
- Stack technique
- python
- Domaine
- documentation
Piste de recherche
Commencez par l’emplacement lié Lib/re/init.py et examinez la documentation existante de re autour de Scanner. Ajoutez une description concise de ce que fait re.Scanner et envisagez la docstring d’exemple proposée. Le travail sera considéré comme terminé lorsque la documentation de la bibliothèque standard expliquera clairement la fonctionnalité et reflétera son utilisation pratique.
Rédigé par le modèle d'indexation à partir du texte de l'issue.
Description
Documentation
re.Scanner is currently marked as "experimental" but was added to the standard library 24 years ago[0].
People seem to think this is an interesting feature[1][2] and a github code search for re.Scanner( gives >500 hits[3],
suggesting people have found practical uses for the class.
Proposal
I suggest we add a few lines to the docs describing what it is and perhaps a short docstring with an example.
Some previously collated discussions:
https://github.com/python/cpython/issues/91308#issuecomment-1093947379
[0]. https://github.com/python/cpython/blob/dbefa88b27ee1f124f782363b139aee3f1ccf590/Lib/re/__init__.py#L327
[1]. https://news.ycombinator.com/item?id=36517749
[2]. https://www.reddit.com/r/ProgrammerTIL/comments/4tpt03/python_til_about_rescanner_which_is_useful_for/
[3]. https://github.com/search?q=re.Scanner%28+language%3APython&type=code
- Langage dominant
- Python
- Étoiles
- 77.2k
- Forks
- 36k
- Merge moyen
- 1 j 11 h
- PR mergées (30 j)
- 565
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.
Autres issues de python/cpython
-
docs pending
Difficulté 2/5 1-3 heures Accessibilité débutants 78/100
-
stdlib type-feature
Difficulté 2/5 1-3 heures Accessibilité débutants 78/100
-
stdlib type-feature
Difficulté 2/5 1-3 heures Accessibilité débutants 72/100
-
build type-bug
Difficulté 2/5 1-3 heures Accessibilité débutants 76/100
-
stdlib topic-email type-feature
Difficulté 2/5 1-3 heures Accessibilité débutants 70/100
Toutes les issues de python/cpython
Issues similaires
-
bug
Difficulté 2/5 1-3 heures Accessibilité débutants 90/100
learningequality/ricecooker#747 ·
-
Difficulté 2/5 1-3 heures Accessibilité débutants 68/100
BSData/horus-heresy-3rd-edition#3171 ·
-
enhancement
Difficulté 2/5 1-3 heures Accessibilité débutants 72/100
-
Difficulté 2/5 1-3 heures Accessibilité débutants 76/100
run-llama/llama_index#23199 ·
-
Difficulté 2/5 1-3 heures Accessibilité débutants 84/100
KhronosGroup/glTF-Blender-IO#2769 ·