reactjs / reactjs/react-docgen
Documentation for JSDoc support
Aperta
Nessuno ha ancora preso questa issue.
- Lingua principale
- TypeScript
- Stelle
- 3.8k
- Fork
- 316
- Merge medio
- 5h 7m
- PR unite (30g)
- 4
Descrizione
In the README there is no mention of JSDoc and what subset of JSDoc syntax react-docgen supports.
Would help to have some documentation explaining the usage with JSDoc.
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 README e dai punti di ingresso del supporto a JSDoc nel repository. Documenta come usare JSDoc con react-docgen e descrivi chiaramente il sottoinsieme della sintassi JSDoc supportato, in modo che i lettori possano comprendere la funzionalità senza dover fare affidamento sulla discussione dell'issue.
Scritto dal modello di indicizzazione a partire dal testo della issue.
Valutazione
- Stack tecnologico
- react, typescript
- Ambito
- documentation
- Tipo di issue
- Documentazione
- Difficoltà
- 2/5
- Tempo stimato
- 1-3 ore
- Stato di attività
- Ferma
- Chiarezza
- Abbastanza chiara
- Idoneità per principianti
- 38/100