Skip to content

Commit 8fe3cee

Browse files
authored
Merge pull request #1117 from 0xbryer/patch-3
Refactor JSDoc for WipCallout to Improve Clarity and Precision Update…
2 parents 3a45fb9 + 61c8288 commit 8fe3cee

File tree

1 file changed

+4
-8
lines changed

1 file changed

+4
-8
lines changed

components/WipCallout.tsx

+4-8
Original file line numberDiff line numberDiff line change
@@ -1,13 +1,9 @@
11
/**
22
* The WipCallout function renders a custom callout component with optional context text for
33
* displaying maintenance messages.
4-
* @param {Props} - The code snippet you provided is a React component named `WipCallout` that
5-
* renders a special callout message. The component takes an optional prop `context` of type string,
6-
* which can be used to customize the message displayed in the callout.
7-
* @returns The WipCallout component is being returned, which is a React element representing a
8-
* custom callout with a message. The message displayed depends on the value of the `context` prop
9-
* passed to the component. If `context` is provided, it will display the provided context message. If
10-
* `context` is not provided, it will display a default maintenance message.
4+
* @param {Props} props - An object containing the optional `context` property, a string used
5+
* to customize the message displayed in the callout.
6+
* @returns {ReactElement} The WipCallout component, representing a custom callout message.
117
*/
128
import type { ReactElement } from 'react';
139
import { useState } from 'react';
@@ -115,4 +111,4 @@ export function AltCallout(props: Props): ReactElement {
115111

116112
export function CGTCallout(props: Props): ReactElement {
117113
return <BetaCallout {...props} featureName="Custom Gas Token" />;
118-
}
114+
}

0 commit comments

Comments
 (0)