Docs for --without-doc-strings argument to configure should mention that builtins can't have their signatures analyzed
Nadie ha tomado este issue todavía.
- Lenguaje dominante
- Python
- Estrellas
- 77.2k
- Forks
- 36k
- Métricas de merge de PR
- Métricas de PR pendientes
Descripción
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
Guía de contribución
Primeros pasos
- Lee el issue completo y luego la guía de contribución del proyecto.
- Comenta en el issue que vas a ocuparte — evita que dos personas hagan lo mismo.
- Haz un fork del repositorio y trabaja en una rama.
- Abre un pull request que haga referencia al número del issue.
Línea de trabajo
Comienza en Doc/using/configure.rst, en la opción --without-doc-strings, y después revisa las secciones referenciadas de Lib/inspect.py y Lib/test/test_capi/test_misc.py. Actualiza la documentación de la opción para explicar el efecto que tiene al inspeccionar las firmas de funciones integradas y verifica la documentación con las comprobaciones o la compilación pertinentes de la documentación.
Escrito por el modelo de indexación a partir del texto del issue.
Evaluación
- Stack tecnológico
- python
- Área
- documentation
- Tipo de issue
- Documentación
- Dificultad
- 1/5
- Tiempo estimado
- 1-3 horas
- Estado de actividad
- Estancado
- Claridad
- Bien especificado
- Aptitud para principiantes
- 35/100