manrajgrover/algorithms-js

Fix JSDocs strings

Open

#22 opened on Aug 1, 2017

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

Repository metrics

Stars
 (200 stars)
PR merge metrics
 (PR metrics pending)

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

Contributor guide

Research direction
Review the existing JSDoc comments in the codebase and update them to follow the JSDoc standard (usejsdoc.org). Ensure functions, parameters, and return types are properly documented.
Tech stack
javascript
Domain
documentation
Issue type
Documentation
DifficultyEstimated implementation difficulty for a new contributor, from 1 for very small changes to 5 for expert-level work.
1
Estimated timeA rough time range for an experienced contributor to investigate, implement, test, and prepare a pull request.
Under 1 hour
Activity statusHow available the issue appears right now: fresh, active, stale, blocked, or waiting on maintainer input.
Fresh
ClarityHow clearly the issue explains the expected change, acceptance criteria, and next step.
Clear
Prerequisites
JavaScript
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
90