Core: Add JSDoc comments to manager-api APIs
#22968
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
Co-authored-by: Tom Coleman <tom@chromatic.com>
JReinhold
changed the title
manager-api APIs
JReinhold
changed the title
manager-api APIsmanager-api APIs
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.
@tmeasday You asked if we should start adding jsdoc comments, I think you're right.
With the power of some AI, I added this.
I did some manual edits, but overall pretty please with the mostly automated additions.
This will give us a blueprint for how to provide additional instructions for methods, arguments.
One of the cool things for example is we can list some usage examples on methods.