Make it possible to disable docstring generation when generating 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
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)
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 dal punto di ingresso dash-generate-components nel repository boilerplate di Dash Typescript e analizza come le props HTML globali ereditate diventano docstring. Riproduci l’output eccessivo con un componente che eredita props globali, quindi determina se il completamento debba consistere nel disabilitare queste descrizioni o nel limitarle alle props originali.
Scritto dal modello di indicizzazione a partire dal testo della issue.
Valutazione
- Stack tecnologico
- python, typescript
- Ambito
- frontend, tooling
- Tipo di issue
- Funzionalità
- Difficoltà
- 4/5
- Tempo stimato
- 3-5 giorni
- Stato di attività
- Ferma
- Chiarezza
- Abbastanza chiara
- Idoneità per principianti
- 35/100