Misleading doc string generation in typescript components
Nessuno ha ancora preso questa issue.
- Lingua principale
- Python
- Stelle
- 24.4k
- Fork
- 2.3k
- Merge medio
- 2g 7h
- PR unite (30g)
- 13
Descrizione
Hi, I am migrating dash-mantine-components to typescript. However, I have been facing some issues with the doc strings generation. The doc strings are not very accurate, in fact, for some prop types, doc string generation just fails.
Example 1
Have a look at how the doc string is generated for the radius prop.


The radius property will accept both strings and numbers but the doc string is misleading.
Example 2
For somewhat complex prop types such as value here, the prop generation just fails with the below error.

Error:
> dash_mantine_components@0.11.0a0 build:backends
> dash-generate-components ./src/ts/components dash_mantine_components -p package-info.json --r-prefix '' --jl-prefix '' --ignore \.test\.
ERROR: "__@iterator@2374" matches reserved word pattern: /^_.*$/
ERROR: "__@unscopables@2376" matches reserved word pattern: /^_.*$/
extract-meta failed
Error generating metadata in dash_mantine_components (status=1)
error: Recipe `build` failed on line 5 with exit code 1
Thanks
Snehil
Guida per i contributori
Apri la guida per i contributori
Come iniziare
- Leggi tutta la issue e poi la guida ai contributi del progetto.
- Commenta sulla issue per dire che te ne occupi tu — evita che due persone facciano lo stesso lavoro.
- Fai un fork del repository e lavora su un branch.
- Apri una pull request che faccia riferimento al numero della issue.
Direzione di ricerca
Inizia con il comando dash-generate-components e il relativo passaggio extract-meta descritto nell’issue. Riproduci la discrepanza nella documentazione di radius e il fallimento della generazione dei valori utilizzando gli esempi collegati di dash-mantine-components. Il lavoro è completato quando i tipi di prop complessi di TypeScript vengono generati correttamente e le stringhe di documentazione risultanti descrivono accuratamente i valori accettati.
Scritto dal modello di indicizzazione a partire dal testo della issue.
Valutazione
- Stack tecnologico
- typescript
- Ambito
- documentation, tooling
- Tipo di issue
- Bug
- Difficoltà
- 4/5
- Tempo stimato
- 3-5 giorni
- Stato di attività
- Ferma
- Chiarezza
- Abbastanza chiara
- Idoneità per principianti
- 35/100