DocGen not recognizing decomposed function parameters

Abierto
#238 2 comentarios 3 reacciones 0 asignados Ver en GitHub

Nadie ha tomado este issue todavía.

Evaluación

Dificultad
3/5
Tiempo estimado
1-2 días
Aptitud para principiantes
42/100
Tipo de issue
Error
Claridad
Bastante claro
Estado de actividad
Estancado
Stack tecnológico
javascript, react
Área
documentation

Línea de trabajo

Comienza reproduciendo el ejemplo documentado de una función con destructuring e inspecciona cómo DocGen extrae los nombres de los parámetros y las propiedades de JSDoc. Se considera terminado cuando la documentación generada reconoce el parámetro user y su descripción en lugar de informar del nombre como { user }, manteniendo al mismo tiempo la estructura de props documentada.

Escrito por el modelo de indexación a partir del texto del issue.

Descripción

improvement

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.

Lenguaje dominante
TypeScript
Estrellas
3.8k
Forks
316
Merge medio
3 h 28 min
PR fusionados (30 d)
6

Guía de contribución

Abrir la guía de contribución

Primeros pasos

  1. Lee el issue completo y luego la guía de contribución del proyecto.
  2. Comenta en el issue que vas a ocuparte — evita que dos personas hagan lo mismo.
  3. Haz un fork del repositorio y trabaja en una rama.
  4. Abre un pull request que haga referencia al número del issue.

Más de reactjs/react-docgen

Todos los issues de reactjs/react-docgen

Issues similares

Más issues de TypeScript

Recibe los nuevos issues en tu correo

Un resumen breve de issues de GitHub para principiantes.