Missed parameters descriptions in Markdown produced by emmylua_doc

Aperta Adatta ai principianti
  • Qualcosa non va?
#1,247 3 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
78/100
Tipo di issue
Bug
Chiarezza
Specificata chiaramente
Stato di attività
Attiva
Stack tecnologico
lua, markdown, rust
Ambito
documentation

Direzione di ricerca

Riproduci il problema con il blocco Lua e emmylua_doc_cli . -f markdown -o ./output, quindi ispeziona ./output/docs/types/Repro.md. Traccia la generazione Markdown per i membri ---@field, in particolare per i campi tipizzati come funzioni, e aggiungi una copertura per le descrizioni che usano @, nessun delimitatore e #; il lavoro è completato quando tutti i campi da a a e mostrano le loro descrizioni.

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

Descrizione

Imagine a file with the following Lua chunk:

---@class Repro
---@field a string @simple type, description is rendered
---@field b fun(x: number): string @function type, description is LOST
---@field c fun(x: number): string description without @ delimiter, LOST
---@field d fun(x: number): string # description with # delimiter, LOST
---@field e function @bare function type, LOST
local Repro = {}

return Repro

Generate a Markdown: emmylua_doc_cli . -f markdown -o ./output.

Inspect ./output/docs/types/Repro.md

Expected result: every field member below has its description rendered.

Actual result: descriptions are rendered only for members with non-function types (a); descriptions of function-typed members (b, c, d, e) are missing.

Version: 0.25.1

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.