From f63a66833b741d8adf5d8d9b733de457fc3652a6 Mon Sep 17 00:00:00 2001 From: Logan Smith <59039788+Lsmith2895@users.noreply.github.com> Date: Tue, 8 Jul 2025 13:19:19 -0400 Subject: [PATCH] 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. --- playground/src/samples/basicSample.ts | 6 +++--- 1 file changed, 3 insertions(+), 3 deletions(-) diff --git a/playground/src/samples/basicSample.ts b/playground/src/samples/basicSample.ts index 1739c478..27dd528c 100644 --- a/playground/src/samples/basicSample.ts +++ b/playground/src/samples/basicSample.ts @@ -1,13 +1,13 @@ /** * Returns the average of two numbers. * - * @remarks - * This method is part of the {@link core-library#Statistics | Statistics subsystem}. - * * @param x - The first input number * @param y - The second input number * @returns The arithmetic mean of `x` and `y` * + * @remarks + * This method is part of the {@link core-library#Statistics | Statistics subsystem}. + * * @beta */ function getAverage(x: number, y: number): number {