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