Reorder TSDoc comments to match HTML rendering for clarity #441
+3
−3
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
Reorder TSDoc comments to match rendered HTML order The sample description for getAverage had its @remarks section before @param and @returns, which differs from how it renders in HTML. This mismatch was confusing for beginners following the playground example. This change reorders the comments to align with their rendered layout for clearer learning.
Lsmith2895
requested review from
iclanton,
octogonz,
apostolisms,
D4N14L,
dmichon-msft and
patmill
as code owners
D4N14L
approved these changes
Jul 9, 2025
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.
Reorder TSDoc comments to match rendered HTML order
The sample description for getAverage had its @remarks section before @param and @returns, which differs from how it renders in HTML. This mismatch was confusing for beginners following the playground example. This change reorders the comments to align with their rendered layout for clearer learning.