reactjs / reactjs/react-docgen

DocGen not recognizing decomposed function parameters

Aperta
#238 2 commenti 3 reazioni 0 assegnatari Vedi su GitHub

Nessuno ha ancora preso questa issue.

improvement
Lingua principale
TypeScript
Stelle
3.8k
Fork
316
Merge medio
5h 7m
PR unite (30g)
4

Descrizione

Within one of my components, I wrote a function that would fetch user data given a username passed as a prop. The function is referenced through lifecycle in multiple places and is documented as below.

/**
 * @param {Object} prop - component props
 * @param {string} prop.user - user whose profile should be fetched
 */
fetch = ({ user }) => {
  // ...
}

The resulting doc does not reference anything from the above and simply puts name: '{ user }' as the parameter. I thought I would be able to use JSDoc syntax.

Guida per i contributori

Apri la guida per i contributori

Come iniziare

  1. Leggi tutta la issue e poi la guida ai contributi del progetto.
  2. Commenta sulla issue per dire che te ne occupi tu — evita che due persone facciano lo stesso lavoro.
  3. Fai un fork del repository e lavora su un branch.
  4. Apri una pull request che faccia riferimento al numero della issue.

Direzione di ricerca

Inizia riproducendo l’esempio documentato di una funzione destrutturata e verifica come DocGen estrae i nomi dei parametri e le proprietà JSDoc. Il lavoro è completato quando la documentazione generata riconosce il parametro user e la relativa descrizione invece di segnalare il nome come { user }, mantenendo al contempo la struttura delle prop documentata.

Scritto dal modello di indicizzazione a partire dal testo della issue.

Valutazione

Stack tecnologico
javascript, react
Ambito
documentation
Tipo di issue
Bug
Difficoltà
3/5
Tempo stimato
1-2 giorni
Stato di attività
Ferma
Chiarezza
Abbastanza chiara
Idoneità per principianti
42/100

Ricevi le nuove issue nella tua casella

Un breve riepilogo di issue GitHub adatte ai principianti.