Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Refactor JSDoc for WipCallout to Improve Clarity and Precision Update… #1117

Merged
merged 1 commit into from
Nov 15, 2024
Merged

Refactor JSDoc for WipCallout to Improve Clarity and Precision Update… #1117

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
12 changes: 4 additions & 8 deletions components/WipCallout.tsx
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -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';
Expand Down Expand Up @@ -115,4 +111,4 @@ export function AltCallout(props: Props): ReactElement {

export function CGTCallout(props: Props): ReactElement {
return <BetaCallout {...props} featureName="Custom Gas Token" />;
}
}
Loading