manrajgrover/algorithms-js

Fix JSDocs strings

Open

#22 aberto em 1 de ago. de 2017

Ver no GitHub
 (2 comments) (0 reactions) (0 assignees)JavaScript (132 forks)github user discovery
documentationenhancementgood first issuehacktoberfest

Métricas do repositório

Stars
 (200 stars)
Métricas de merge de PR
 (Métricas PR pendentes)

Description

Since auto documentation generation depends on JS DocStrings, there is need to fix and provide as much information possible.

Reference: http://usejsdoc.org/index.html

Guia do colaborador

Direção de pesquisa
Revise os comentários JSDoc existentes no código e atualize os para seguir o padrão JSDoc (usejsdoc.org). Garanta que funções, parâmetros e tipos de retorno estejam devidamente documentados.
Pilha de tecnologia
javascript
Domain
documentation
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
JavaScript
Simpatia para novatosUma pontuação de 1 a 100 que estima o quão acessível este issue é para colaboradores iniciantes.
90