seangwright/typescript-functional-extensions
Docs: More Consistent JSDoc comments
开放
#1 创建于 2021年12月27日
documentationgood first issuehelp wanted
仓库指标
- 星标
- (39 个星标)
- PR 合并指标
- (PR 指标待抓取)
描述
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