seangwright/typescript-functional-extensions

Docs: More Consistent JSDoc comments

オープン

#1 opened on 2021/12/27

 (0 件のコメント) (0 件のリアクション) (0 人の担当者)TypeScript (6 件のフォーク)auto 404
documentationgood first issuehelp wanted

Repository metrics

Stars
 (39 個のスター)
PR merge metrics
 (PR metrics pending)

説明

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

コントリビューターガイド