Docs for --without-doc-strings argument to configure should mention that builtins can't have their signatures analyzed
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
In the documentation for ./configure the --without-doc-strings option does not mention that removing docstrings also makes it impossible to use the inspect module to get the signature for builtins.
This seems to be an intentional limitation:
- https://github.com/python/cpython/blob/main/Lib/test/test_capi/test_misc.py#L164
- https://github.com/python/cpython/blob/main/Lib/inspect.py#L2528-L2534
I opened a ticket about a downstream problem due to this in the Django project and there was some confusion about what this compile-time option does.
Can the documentation be improved to mention this? The current docs discuss the docstrings limitation but unless you know about the internals of CPython it can be unclear why this would also make it impossible to inspect builtins.
I’m happy to file an PR to update the text in the docs to discuss this limitation, though I may not fully understand the scope of the problem or what else should be mentioned there.
Linked PRs
- gh-144746
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 Doc/using/configure.rst, au niveau de l’option --without-doc-strings, puis examinez les sections référencées de Lib/inspect.py et Lib/test/test_capi/test_misc.py. Mettez à jour la documentation de l’option pour expliquer son effet sur l’inspection des signatures des fonctions intégrées, et vérifiez la documentation avec les contrôles ou la compilation de documentation appropriés.
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é
- 1/5
- Temps estimé
- 1-3 heures
- Activité
- À l'abandon
- Clarté
- Clairement spécifiée
- Accessibilité débutants
- 35/100