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

Aperta Adatta ai principianti
#498 0 commenti 0 reazioni 0 assegnatari Vedi su GitHub

I maintainer di solito rispondono entro 1 giorno

Nessuno ha ancora preso questa issue.

Valutazione

Difficoltà
2/5
Tempo stimato
1-3 ore
Idoneità per principianti
84/100
Tipo di issue
Documentazione
Chiarezza
Specificata chiaramente
Stato di attività
Attiva
Stack tecnologico
javascript, react

Direzione di ricerca

Leggi il JSDoc di dismissedTips in packages/pivotkit-react/src/index.js e confrontalo con cleanDismissed in tips.js e con i tipi generati. Aggiorna le forme accettate documentate in modo che corrispondano all’issue: "*", "-explanations", "-fields" e gli ID dei suggerimenti. Il lavoro è completo quando il JSDoc e i tipi generati corrispondono a questo elenco ed escludono le forme eliminate.

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

Descrizione

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.

Lingua principale
JavaScript
Stelle
1
Fork
1
Merge medio
3h 34m
PR unite (30g)
213

Preparare l'ambiente

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.

Altre issue di eizedev/pivotkit

Tutte le issue di eizedev/pivotkit

Issue simili

Altre issue su JavaScript

Ricevi le nuove issue nella tua casella

Un breve riepilogo di issue GitHub adatte ai principianti.