josephg/node-foundationdb

Port documentation into typescript doc comments

Aberta

#26 aberto em 15 de mar. de 2019

Ver no GitHub
 (0 comentário) (0 reação) (0 responsável)TypeScript (20 forks)github user discovery
enhancementgood first issuehelp wanted

Métricas do repositório

Stars
 (129 estrelas)
Métricas de merge de PR
 (Nenhuma PRs mesclada em 30d)

Description

There's lots of transaction & database methods which are missing documentation comments.

We should do a pass adding typescript tsdoc - compatible doc comments for all the normal function in (at a minimum) lib/transaction.ts and lib/database.ts.

This documentation is picked up by documentation tools and by editors (like vs code), which makes it very handy while using the API.

Guia do colaborador

Direção de pesquisa
Examine os arquivos TypeScript existentes (lib/transaction.ts, lib/database.ts) e adicione comentários de documentação compatíveis com TSDoc a todas as funções e métodos públicos, seguindo as convenções usadas em outras partes do código.
Pilha de tecnologia
typescript
Domain
apibackend
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.
Meio dia
Status da atividadeQuão disponível o issue aparece agora: novo, ativo, obsoleto, bloqueado ou aguardando entrada do mantenedor.
Ativo
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.
85