Add basic documentation for built-in types

Aperta Adatta ai principianti
  • Qualcosa non va?
#1,363 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à
2/5
Tempo stimato
1-3 ore
Idoneità per principianti
68/100
Tipo di issue
Documentazione
Chiarezza
Abbastanza chiara
Stato di attività
Attiva
Stack tecnologico
rust
Ambito
documentation

Direzione di ricerca

Inizia dalla documentazione delle annotazioni in docs/emmylua_doc/annotations_EN e scopri come sono organizzate e collegate le sue pagine. Aggiungi una pagina che elenchi i tipi integrati, descriva brevemente ciascuno e spieghi distinzioni poco chiare come any e unknown; inserisci un collegamento alla pagina nella documentazione delle annotazioni pertinente. Il lavoro è completato quando la pagina tratta i tipi integrati e la documentazione esistente rimanda a essa.

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

Descrizione

Problem

The EmmyLua documentation describes annotations, but I could not find a dedicated page documenting the built-in types.

This makes it difficult for users to understand the meaning and intended usage of types such as any, unknown, nil, never, and void.

For example, unknown is declared as a distinct type from any, but its intended semantics and differences from any are not documented. As a result, users may have difficulty determining whether the analyzer's behavior is intentional or an implementation limitation.

Proposal

Add a basic documentation page for built-in types under:

docs/emmylua_doc/annotations_EN

The page could provide:

  • A list of built-in types
  • A brief description of each type
  • The intended differences between types with potentially confusing semantics, especially any and unknown
  • Links from the existing annotation documentation, where appropriate

This does not require changes to the type checker. A brief description of the intended behavior of each built-in type would already make the documentation more useful.

Lingua principale
Rust
Stelle
527
Fork
110
Merge medio
2g 6h
PR unite (30g)
32

Preparare l'ambiente

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 EmmyLuaLs/emmylua-analyzer-rust

Tutte le issue di EmmyLuaLs/emmylua-analyzer-rust

Issue simili

Altre issue su Rust

Ricevi le nuove issue nella tua casella

Un breve riepilogo di issue GitHub adatte ai principianti.