Skip to content

Commit f63a668

Browse files
authored
Reorder TSDoc comments to match HTML rendering for clarity
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.
1 parent 63b9411 commit f63a668

File tree

1 file changed

+3
-3
lines changed

1 file changed

+3
-3
lines changed

playground/src/samples/basicSample.ts

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,13 +1,13 @@
11
/**
22
* Returns the average of two numbers.
33
*
4-
* @remarks
5-
* This method is part of the {@link core-library#Statistics | Statistics subsystem}.
6-
*
74
* @param x - The first input number
85
* @param y - The second input number
96
* @returns The arithmetic mean of `x` and `y`
107
*
8+
* @remarks
9+
* This method is part of the {@link core-library#Statistics | Statistics subsystem}.
10+
*
1111
* @beta
1212
*/
1313
function getAverage(x: number, y: number): number {

0 commit comments

Comments
 (0)