Skip to content

Misleading doc string generation in typescript components #2255

Open
@snehilvj

Description

@snehilvj

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.

ss1

ss2

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.

ss3

Error:

> [email protected] 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

Metadata

Metadata

Assignees

Labels

P3backlogbugsomething broken

Type

No type

Projects

No projects

Milestone

No milestone

Relationships

None yet

Development

No branches or pull requests

Issue actions