Clarify __lazy_import__ docstring in bltinmodule.c

Aperta
#161,715 0 commenti 0 reazioni 0 assegnatari Vedi su GitHub

I maintainer di solito rispondono entro 1 giorno

Nessuno ha ancora preso questa issue.

Valutazione

Difficoltà
1/5
Tempo stimato
Meno di un'ora
Idoneità per principianti
1/100
Tipo di issue
Documentazione
Chiarezza
Specificata chiaramente
Stato di attività
Ferma
Stack tecnologico
c, python
Ambito
documentation

Direzione di ricerca

The docstring is in bltinmodule.c in the __lazy_import__ clinic input. Update the wording to refer to types.LazyImportType and describe the module as already lazily imported. Check the generated clinic code and tests or documentation that cover this builtin; done when the docstring reflects both requested corrections.

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

Descrizione

docs topic-lazy-imports
Documentation

Docstring is currently:

/*[clinic input]
__lazy_import__ as builtin___lazy_import__

    name: object
    globals: object(c_default="NULL") = None
    locals: object(c_default="NULL") = None
    fromlist: object(c_default="NULL") = ()
    level: int = 0

Lazily imports a module.

Returns either the module to be imported or a imp.lazy_module object
which indicates the module to be lazily imported.
[clinic start generated code]*/

Should change because:

  • what is imp.lazy_module? should be types.LazyImportType
  • it's not to be [lazily] imported, it's [lazily] imported.
Linked PRs
  • gh-161716
Lingua principale
Python
Stelle
78.2k
Fork
36.6k
Merge medio
19h 57m
PR unite (30g)
630

Preparare l'ambiente

Apri in Codespaces

Avvia il container di sviluppo del progetto nel browser, con il tuo account GitHub.

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.

Altre issue di python/cpython

Tutte le issue di python/cpython

Issue simili

Altre issue su Python

Ricevi le nuove issue nella tua casella

Un breve riepilogo di issue GitHub adatte ai principianti.