Follow jsdoc and tsdoc more closely, especially @example#1562
Merged
shadowspawn merged 1 commit intotj:developfrom Jul 9, 2021
Merged
Follow jsdoc and tsdoc more closely, especially @example#1562shadowspawn merged 1 commit intotj:developfrom
shadowspawn merged 1 commit intotj:developfrom
Conversation
shadowspawn
added
the
pending release
shadowspawn
removed
the
pending release
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
2 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.
Pull Request
Problem
The TSDoc and JSDoc comments for
@examplewere not following the style shown in the references:Solution
Follow the documented syntax and style for the code examples.
Clean up a few other pieces of documentation too, using four space for literal blocks, and converting some JSDoc to TSDoc.