Skip to content

Commit 4968d56

Browse files
committed
improve doc comments
1 parent 0adf620 commit 4968d56

File tree

1 file changed

+6
-11
lines changed

1 file changed

+6
-11
lines changed

src/components/banner/index.tsx

Lines changed: 6 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -7,11 +7,11 @@ import styles from './banner.module.scss';
77
type BannerType = {
88
/** This is an array of strings or RegExps to feed into new RegExp() */
99
appearsOn: (string | RegExp)[];
10-
/** String that is the label for the call to action button */
10+
/** The label for the call to action button */
1111
linkText: string;
12-
/** String that is the destination url of the call to action button */
12+
/** The destination url of the call to action button */
1313
linkURL: string;
14-
/** String for the text of the banner */
14+
/** The main text of the banner */
1515
text: string;
1616
/** Optional ISO Date string that will hide the banner after this date without the need for a rebuild */
1717
expiresOn?: string;
@@ -24,14 +24,9 @@ type BannerType = {
2424
// Example:
2525
//
2626
// Examples:
27-
// const SHOW_BANNER_ON = []; // This is disabled
28-
// const SHOW_BANNER_ON = ['^/$']; // This is enabled on the home page
29-
// const SHOW_BANNER_ON = ['^/welcome/']; // This is enabled on the "/welcome" page
30-
// const BANNER_TEXT =
31-
// 'your message here';
32-
// const BANNER_LINK_URL =
33-
// 'link here';
34-
// const BANNER_LINK_TEXT = 'your cta here';
27+
// appearsOn = []; // This is disabled
28+
// appearsOn = ['^/$']; // This is enabled on the home page
29+
// appearsOn = ['^/welcome/']; // This is enabled on the "/welcome" page
3530
// const BANNERS = [
3631
//
3732
// This one will take precedence over the last banner in the array

0 commit comments

Comments
 (0)