seangwright/typescript-functional-extensions

Docs: More Consistent JSDoc comments

Open

#1 opened on Dec 27, 2021

View on GitHub
 (0 comments) (0 reactions) (0 assignees)TypeScript (6 forks)auto 404
documentationgood first issuehelp wanted

Repository metrics

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

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

Contributor guide

Research direction
Review existing JSDoc comments in the codebase, identify inconsistencies, and propose a style guide for JSDoc comments.
Tech stack
typescript
Domain
None
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.
1-3 hours
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
typescript
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
90