seangwright/typescript-functional-extensions

Docs: More Consistent JSDoc comments

Aberta

#1 aberto em 27 de dez. de 2021

Ver no GitHub
 (0 comentário) (0 reação) (0 responsável)TypeScript (6 forks)auto 404
documentationgood first issuehelp wanted

Métricas do repositório

Stars
 (39 estrelas)
Métricas de merge de PR
 (Métricas PR pendentes)

Description

The language describing methods/parameters/return types isn't very consistent across the library.

We need to decide on a few things and then clean it all up:

  • Past/present tense
  • Verbose vs terse method description
    • Details in description or param/return type annotations
  • Comments just for method overload signatures or also for implementation
  • Comments on utility types

Guia do colaborador

Direção de pesquisa
Revise os comentários JSDoc existentes no código, identifique inconsistências e proponha um guia de estilo para comentários JSDoc.
Pilha de tecnologia
typescript
Domain
None
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.
1-3 horas
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
typescript
Simpatia para novatosUma pontuação de 1 a 100 que estima o quão acessível este issue é para colaboradores iniciantes.
90