docs: developer gaps from the 0.7.0 review

Fechada
#512 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
4/5
Tempo estimado
3-5 dias
Facilidade para iniciantes
52/100
Tipo de issue
Documentação
Clareza
Claramente especificada
Status de atividade
Ativa
Stack de tecnologia
javascript
Domínio
documentation

Direção de pesquisa

Start with docs/reference/rest.md and engine.md, then locate the exports from pivotkit-core/import, pivotkit-element, and pivotkit-react to confirm their names and chart constants. Update the examples and descriptions for authentication, 403 errors, invalid filters, and the differing view type names. Done when each listed gap is documented accurately; the issue does not name tests to run.

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

Descrição

documentation

Developer-facing gaps from the full review before 0.7.0:

  • docs/reference/rest.md embed example needs PIVOTKIT_TOKEN or auth.tokens and leaves rows undefined.
  • 403 NOT_ALLOWED text says "your token may not download files" when the server has no sign-in.
  • Undocumented exports: cleanText (pivotkit-core/import) and the chart constants BOTTOM_LEGEND_ROOM, CATEGORY_LABEL_WIDTH, GROUP_LABEL_ROOM, RIGHT_LEGEND_MIN_WIDTH, SLANTED_LABEL_WIDTH.
  • computePivot drops an invalid filter and returns the unfiltered pivot; engine.md should tell hosts to check issues for errors (or a strict option).
  • pivotkit-element exports PivotView, pivotkit-react uses ViewInput for the same thing.
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.