Skip to content

Docs: More Consistent JSDoc comments #1

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom
Open
seangwright opened this issue Dec 27, 2021 · 0 comments
Open

Docs: More Consistent JSDoc comments #1

seangwright opened this issue Dec 27, 2021 · 0 comments
Labels
documentation Improvements or additions to documentation good first issue Good for newcomers help wanted Extra attention is needed

Comments

@seangwright
Copy link
Owner

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
@seangwright seangwright added documentation Improvements or additions to documentation help wanted Extra attention is needed good first issue Good for newcomers labels Dec 27, 2021
@GregOnNet GregOnNet mentioned this issue Mar 18, 2025
Closed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees
No one assigned
Labels
documentation Improvements or additions to documentation good first issue Good for newcomers help wanted Extra attention is needed
Projects
None yet
Milestone
No milestone
Development

No branches or pull requests
1 participant
@seangwright