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

Aberta Para iniciantes
#498 0 comentários 0 reações 0 responsáveis Ver no GitHub

Mantenedores costumam responder em até 1 dia

Ninguém assumiu esta issue ainda.

Avaliação

Dificuldade
2/5
Tempo estimado
1-3 horas
Facilidade para iniciantes
84/100
Tipo de issue
Documentação
Clareza
Claramente especificada
Status de atividade
Ativa
Stack de tecnologia
javascript, react

Direção de pesquisa

Leia o JSDoc de dismissedTips em packages/pivotkit-react/src/index.js e compare-o com cleanDismissed em tips.js e com os tipos gerados. Atualize os formatos aceitos documentados para corresponderem à issue: "*", "-explanations", "-fields" e IDs de dicas. O trabalho estará concluído quando o JSDoc e os tipos gerados concordarem com essa lista e excluírem os formatos removidos.

Escrita pelo modelo de indexação a partir do texto da issue.

Descrição

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.

Linguagem predominante
JavaScript
Estrelas
1
Forks
1
Merge médio
3h 21min
PRs com merge (30d)
250

Preparar o ambiente

Primeiros passos

  1. Leia a issue inteira e depois o guia de contribuição do projeto.
  2. Comente na issue dizendo que vai assumir — evita que duas pessoas façam o mesmo trabalho.
  3. Faça um fork do repositório e trabalhe em uma branch.
  4. Abra um pull request que referencie o número da issue.

Mais de eizedev/pivotkit

Todas as issues de eizedev/pivotkit

Issues semelhantes

Mais issues de JavaScript

Receba novas issues na sua caixa de entrada

Um resumo curto de issues do GitHub para quem está começando.