fill out JSDocs with examples#1141
Open
jbolda wants to merge 9 commits intov4-1-alphafrom
Open
Conversation
commit: |
taras
reviewed
Mar 22, 2026
taras
reviewed
Mar 22, 2026
taras
reviewed
Mar 22, 2026
taras
reviewed
Mar 22, 2026
taras
reviewed
Mar 22, 2026
Co-authored-by: Taras Mankovski <tarasm@gmail.com>
cowboyd
reviewed
Apr 2, 2026
Member
cowboyd
left a comment
cowboyd
left a comment
There was a problem hiding this comment.
There are some where I'm not so sure we need examples. Or if we do have them, they should be very, very concise.
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
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
3 participants
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.
Motivation
Filling out the JSDocs a bit more. These show up both on the website, but also in IDEs.
Closes #1139.
Approach
Fix a few broken bits, and add more examples.