Docs: More Consistent JSDoc comments

seangwright / typescript-functional-extensions

A TypeScript implementation of the C# library CSharpFunctionalExtensions, including synchronous and asynchronous Maybe and Result monads.

MIT License

33 stars 4 forks source link

Open seangwright opened 2 years ago

seangwright commented 2 years ago

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