docs(batch): review API docs & README #2562
Merged
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
boring-cyborg
bot
added
batch
pull-request-size
bot
added
the
size/XL
boring-cyborg
bot
added
the
documentation
am29d
approved these changes
May 23, 2024
|
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.
Summary
Changes
This PR overhauls the JSDoc comments on each type, function, class, and method of the Batch Processing utility so that it provides better and relevant info to customers using the API docs or wanting to get contextual info within their IDE.
The work here followed the guidelines established in the linked issue and its parent, and also refreshes the README file for the utility to be more focused and in line with the new style.
Finally, while there, I also made some minor touch-ups to the code snippets of the utility so that they're more concise.
Issue number: closes #2380
By submitting this pull request, I confirm that you can use, modify, copy, and redistribute this contribution, under the terms of your choice.
Disclaimer: We value your time and bandwidth. As such, any pull requests created on non-triaged issues might not be successful.