Misleading doc string generation in typescript components
Dieses Issue hat noch niemand übernommen.
- Vorherrschende Sprache
- Python
- Sterne
- 24.4k
- Forks
- 2.3k
- Ø Merge
- 2 T. 7 Std.
- Gemergte PRs (30 T.)
- 13
Beschreibung
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
Beitragsleitfaden
Erste Schritte
- Lies das ganze Issue und danach den Beitragsleitfaden des Projekts.
- Schreib ins Issue, dass du es übernimmst — das erspart doppelte Arbeit.
- Forke das Repository und arbeite in einem Branch.
- Öffne einen Pull Request, der die Issue-Nummer nennt.
Rechercherichtung
Beginne mit dem Befehl dash-generate-components und dem darin beschriebenen extract-meta-Schritt. Reproduziere die Diskrepanz in der radius-Dokumentation und den Fehler bei der Wertgenerierung anhand der verknüpften dash-mantine-components-Beispiele. Als erledigt gilt, dass komplexe TypeScript-Prop-Typen erfolgreich generiert werden und die resultierenden Dokumentationszeichenfolgen die akzeptierten Werte korrekt beschreiben.
Vom Indexierungsmodell aus dem Issue-Text verfasst.
Bewertung
- Tech-Stack
- typescript
- Bereich
- documentation, tooling
- Issue-Typ
- Bug
- Schwierigkeit
- 4/5
- Geschätzter Aufwand
- 3-5 Tage
- Aktivitätsstatus
- Veraltet
- Klarheit
- Größtenteils klar
- Anfängerfreundlichkeit
- 35/100