downshift-js/downshift

JSDoc comments in typings to enhance usability of props

Open

#1.057 aberto em 20 de mai. de 2020

Ver no GitHub
 (2 comments) (3 reactions) (0 assignees)JavaScript (980 forks)batch import
chorehelp wanted

Métricas do repositório

Stars
 (11.761 stars)
Métricas de merge de PR
 (Mesclagem média 6d 9h) (5 fundiu PRs em 30d)

Description

  • downshift version: 5.4.0

Problem description:

Currently, all descriptions of props are found through Github. They are nice and all, but it is a hassle to access the repo every time I need to read further up on the props.

Suggested solution:

Add all descriptions to index.d.ts from the README's in a JSDoc-like format (e.g. typedoc), thus having the descriptions readily available through your IDE/editor of choice

Here is an example of what it may look like in VSCode when a line was added. image

Guia do colaborador

Direção de pesquisa
Adicione comentários JSDoc para cada prop no index.d.ts extraindo descrições do README ou comentários do código fonte.
Pilha de tecnologia
typescriptjavascriptreact
Domain
frontend
Tipo Issue
Documentação
DifficultyDificuldade de implementação estimada para um novo contribuidor, de 1 para alterações muito pequenas a 5 para trabalho de nível especializado.
1
Tempo estimadoUm intervalo de tempo aproximado para um colaborador experiente investigar, implementar, testar e preparar um pull request.
Menos de 1 hora
Status da atividadeQuão disponível o issue aparece agora: novo, ativo, obsoleto, bloqueado ou aguardando entrada do mantenedor.
Recente
ClarityCom que clareza o issue explica a mudança esperada, os critérios de aceitação e a próxima etapa.
Claro
Prerequisites
TypeScriptJSDoc
Simpatia para novatosUma pontuação de 1 a 100 que estima o quão acessível este issue é para colaboradores iniciantes.
90