Add JSDoc comments for existing API docs #870
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
timocov
suggested changes
Oct 13, 2021
timocov
suggested changes
Oct 19, 2021
Replaced 0 and 1 with 'off' and 'error' accordingly (it looks like more explicit way to operate with eslint rules)
timocov
reviewed
Oct 20, 2021
timocov
approved these changes
Oct 20, 2021
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Type of PR: enhancement
PR checklist:
Overview of change:
This PR moves the hand-written API documentation that currently exists in our docs into JSDoc comments on the appropriate types.
When we have these JSDoc comments we can then use them to auto-generate API documentation.
Theres still work to be done to improve these API docs but this is meant to be a first step that uses the documentation we already have.