manrajgrover/algorithms-js

Fix JSDocs strings

Open

#22 ouverte le 1 août 2017

Voir sur GitHub
 (2 commentaires) (0 réactions) (0 assignés)JavaScript (132 forks)github user discovery
documentationenhancementgood first issuehacktoberfest

Métriques du dépôt

Stars
 (200 stars)
Métriques de merge PR
 (Métriques PR en attente)

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

Guide contributeur

Direction de recherche
Passez en revue les commentaires JSDoc existants dans la base de code et mettez les à jour pour suivre la norme JSDoc (usejsdoc.org). Assurez vous que les fonctions, les paramètres et les types de retour sont correctement documentés.
Stack technique
javascript
Domaine
documentation
Type d'issue
Documentation
DifficultéDifficulté estimée pour un nouveau contributeur, de 1 pour un très petit changement à 5 pour un travail expert.
1
Temps estiméFourchette de temps approximative pour investiguer, implémenter, tester et préparer une pull request.
Moins d'une heure
Statut d'activitéDisponibilité apparente de l'issue : fraîche, active, ancienne, bloquée ou en attente d'un mainteneur.
Récente
ClartéClarté avec laquelle l'issue explique le changement attendu, les critères d'acceptation et la prochaine étape.
Claire
Prérequis
JavaScript
Accessibilité débutantScore de 1 à 100 estimant l'accessibilité de cette issue pour un premier contributeur.
90