feat(types): add JSDoc annotations #286
Draft
Conversation
This file contains hidden or 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
|
Very cool! I like it. |
|
Thank you. I continue in same style. |
|
I am currently searching for all public API subjects. I found that some functions and complex overloads are not documented. There are also some minor overloads that are not decorated as overloads and some inconsistency in the documentation headers. Should I create Issues or will we do all the side work within this request? |
|
We can pack all of the docs updates in one PR and add JSDocs in a separate one. If you think there are inconsistencies, you can create a PR or issue for that first (on sie side). This should be merged before adding JSDocs on top of it. |
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.
No description provided.