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

Ouverte Adaptée aux débutants
#498 0 commentaires 0 réactions 0 personnes assignées Voir sur GitHub

Les mainteneurs répondent en général sous 1 jour

Personne n'a encore pris cette issue.

Évaluation

Difficulté
2/5
Temps estimé
1-3 heures
Accessibilité débutants
84/100
Type d'issue
Documentation
Clarté
Clairement spécifiée
Activité
Active
Stack technique
javascript, react

Piste de recherche

Lisez le JSDoc de dismissedTips dans packages/pivotkit-react/src/index.js et comparez-le à cleanDismissed dans tips.js ainsi qu’aux types générés. Mettez à jour les formes acceptées documentées pour qu’elles correspondent à l’issue : "*", "-explanations", "-fields" et les identifiants des conseils. Le travail est terminé lorsque le JSDoc et les types générés correspondent à cette liste et excluent les formes supprimées.

Rédigé par le modèle d'indexation à partir du texte de l'issue.

Description

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.

Langage dominant
JavaScript
Étoiles
1
Forks
1
Merge moyen
3 h 21 min
PR mergées (30 j)
250

Préparer son environnement

Par où commencer

  1. Lisez l'issue en entier, puis le guide de contribution du projet.
  2. Signalez en commentaire que vous la prenez — cela évite que deux personnes fassent le même travail.
  3. Forkez le dépôt et travaillez sur une branche.
  4. Ouvrez une pull request qui référence le numéro de l'issue.

Autres issues de eizedev/pivotkit

Toutes les issues de eizedev/pivotkit

Issues similaires

Plus d'issues JavaScript

Recevez les nouvelles issues par e-mail

Un résumé court des issues GitHub adaptées aux débutants.