react: dismissedTips JSDoc describes entries cleanDismissed drops, misses -fields

Abierto Apto para principiantes
#498 0 comentarios 0 reacciones 0 asignados Ver en GitHub

Los mantenedores suelen responder en 1 día

Nadie ha tomado este issue todavía.

Evaluación

Dificultad
2/5
Tiempo estimado
1-3 horas
Aptitud para principiantes
84/100
Tipo de issue
Documentación
Claridad
Bien especificado
Estado de actividad
Activo
Stack tecnológico
javascript, react

Línea de trabajo

Lee el JSDoc de dismissedTips en packages/pivotkit-react/src/index.js y compáralo con cleanDismissed en tips.js y los tipos generados. Actualiza las formas aceptadas documentadas para que coincidan con el issue: "*", "-explanations", "-fields" e IDs de consejos. Está listo cuando el JSDoc y los tipos generados coincidan con esa lista y excluyan las formas descartadas.

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

Descripción

documentation idea

The JSDoc of dismissedTips in packages/pivotkit-react/src/index.js (lines 161-163 on main) still describes open:<section> and closed:<section> entries as meaningful and does not list the -fields switch. cleanDismissed in tips.js drops open:/closed: entries, and -fields (FIELDS_COLLAPSED) is a real switch: folding the field list to the rail adds it and calls onTipDismiss with id: null.

Not affected: behaviour and the docs pages, which #497 corrects.

Fix: align the JSDoc (and the generated types) with cleanDismissed: "*", "-explanations", "-fields" and tip ids; other shapes are dropped.

Lenguaje dominante
JavaScript
Estrellas
1
Forks
1
Merge medio
3 h 34 min
PR fusionados (30 d)
213

Preparar el entorno

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 eizedev/pivotkit

Todos los issues de eizedev/pivotkit

Issues similares

Más issues de JavaScript

Recibe los nuevos issues en tu correo

Un resumen breve de issues de GitHub para principiantes.