reactjs / reactjs/react-docgen

Generate docs for hooks

Abierto
#332 12 comentarios 18 reacciones 0 asignados Ver en GitHub

Nadie ha tomado este issue todavía.

Lenguaje dominante
TypeScript
Estrellas
3.8k
Forks
316
Merge medio
5 h 7 min
PR fusionados (30 d)
4

Descripción

Since hooks have been released a while back, it would be nice to be able to generate docs for them.

For example, for a simple hook:

import {useState} from 'react';

/**
 * A hook to do something
 *
 * @param {object} params
 * @param {boolean} [params.disabled] Disable the thing
 * @returns {boolean}
 */
const useMyHook = (params) => {
  const [isUsing, setUsing] = useState(false);
  // Some logic here to invoke setUsing()
  return isUsing;
};

export default useMyHook;

There is not way to generate some docs. Or is there and I just can't find it?

NOTE: I am actually using react-styleguidist which uses this lib to generate component docs.

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.

Línea de trabajo

No se indica ningún archivo fuente ni ninguna prueba. Empieza examinando la ruta de generación existente de react-docgen y la integración con react-styleguidist mencionada en el issue; se considera terminado cuando los hooks con JSDoc, como en el ejemplo, producen documentación generada utilizable.

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

Evaluación

Stack tecnológico
react, typescript
Área
documentation
Tipo de issue
Nueva funcionalidad
Dificultad
5/5
Tiempo estimado
Más de una semana
Estado de actividad
Estancado
Claridad
Necesita aclaración
Aptitud para principiantes
35/100

Recibe los nuevos issues en tu correo

Un resumen breve de issues de GitHub para principiantes.