From 61c82882fd51f40b7e680cabd51dc2d2bc8d962b Mon Sep 17 00:00:00 2001 From: Bryer <0xbryer@gmail.com> Date: Fri, 15 Nov 2024 13:46:37 +0200 Subject: [PATCH] Refactor JSDoc for WipCallout to Improve Clarity and Precision Update WipCallout.tsx This pull request addresses an issue with the JSDoc comments for the WipCallout function. The original JSDoc was overly verbose, included redundant information, and misused the @param directive. The updated JSDoc provides a more precise and compact description while adhering to standard documentation practices. --- components/WipCallout.tsx | 12 ++++-------- 1 file changed, 4 insertions(+), 8 deletions(-) diff --git a/components/WipCallout.tsx b/components/WipCallout.tsx index 2d0b96ccd..ae3600044 100644 --- a/components/WipCallout.tsx +++ b/components/WipCallout.tsx @@ -1,13 +1,9 @@ /** * The WipCallout function renders a custom callout component with optional context text for * displaying maintenance messages. - * @param {Props} - The code snippet you provided is a React component named `WipCallout` that - * renders a special callout message. The component takes an optional prop `context` of type string, - * which can be used to customize the message displayed in the callout. - * @returns The WipCallout component is being returned, which is a React element representing a - * custom callout with a message. The message displayed depends on the value of the `context` prop - * passed to the component. If `context` is provided, it will display the provided context message. If - * `context` is not provided, it will display a default maintenance message. + * @param {Props} props - An object containing the optional `context` property, a string used + * to customize the message displayed in the callout. + * @returns {ReactElement} The WipCallout component, representing a custom callout message. */ import type { ReactElement } from 'react'; import { useState } from 'react'; @@ -115,4 +111,4 @@ export function AltCallout(props: Props): ReactElement { export function CGTCallout(props: Props): ReactElement { return ; -} \ No newline at end of file +}