python / python/cpython

Docs for --without-doc-strings argument to configure should mention that builtins can't have their signatures analyzed

Aperta
#100,150 0 commenti 0 reazioni 0 assegnatari Vedi su GitHub

Nessuno ha ancora preso questa issue.

docs
Lingua principale
Python
Stelle
77.2k
Fork
36k
Metriche di merge delle PR
Metriche PR in attesa

Descrizione

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:

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

Guida per i contributori

Apri la guida per i contributori

Come iniziare

  1. Leggi tutta la issue e poi la guida ai contributi del progetto.
  2. Commenta sulla issue per dire che te ne occupi tu — evita che due persone facciano lo stesso lavoro.
  3. Fai un fork del repository e lavora su un branch.
  4. Apri una pull request che faccia riferimento al numero della issue.

Direzione di ricerca

Inizia in Doc/using/configure.rst, all’opzione --without-doc-strings, quindi esamina le sezioni referenziate di Lib/inspect.py e Lib/test/test_capi/test_misc.py. Aggiorna la documentazione dell’opzione per spiegare l’effetto sull’ispezione delle firme delle funzioni builtin e verifica la documentazione con i controlli o la compilazione della documentazione pertinenti.

Scritto dal modello di indicizzazione a partire dal testo della issue.

Valutazione

Stack tecnologico
python
Ambito
documentation
Tipo di issue
Documentazione
Difficoltà
1/5
Tempo stimato
1-3 ore
Stato di attività
Ferma
Chiarezza
Specificata chiaramente
Idoneità per principianti
35/100

Ricevi le nuove issue nella tua casella

Un breve riepilogo di issue GitHub adatte ai principianti.