Make it possible to disable docstring generation when generating components
Nobody has claimed this yet.
- Dominant language
- Python
- Stars
- 24.4k
- Forks
- 2.3k
- Avg merge
- 2d 7h
- Merged PRs (30d)
- 13
Description
When using the Dash Typescript boilerplate repo to generate components, there appears to be no way to disable the docstring generation. As a result, components which inherit global HTML props, will have 8k lines of doc strings describing all the props. This is excessive and should probably be optional.
I think it would be helpful if we had a flag for the dash-generate-components to either disable the docstring generation, or limit it (e.g. generate descriptions only for the component's original props - excluding descriptions for props that were inherited from global attributes)
Contributor guide
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
Research direction
Start at the dash-generate-components entry point in the Dash Typescript boilerplate repo and inspect how inherited global HTML props become docstrings. Reproduce the excessive output with a component that inherits global props, then determine whether completion should mean disabling those descriptions or limiting them to original props.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- python, typescript
- Domain
- frontend, tooling
- Issue type
- Feature
- Difficulty
- 4/5
- Estimated time
- 3-5 days
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 35/100