docs(typography): Add a message to Sup/Sub component to denote they a…

…re sub components
telus · Sep 5, 2017 · 8cc4c88 · 8cc4c88
1 parent e94a9c0
commit 8cc4c88
Show file tree

Hide file tree

Showing 6 changed files with 18 additions and 0 deletions.
diff --git a/src/components/Typography/DisplayHeading/DisplayHeadingSub/DisplayHeadingSub.jsx b/src/components/Typography/DisplayHeading/DisplayHeadingSub/DisplayHeadingSub.jsx
@@ -6,6 +6,9 @@ import styles from '../DisplayHeading.modules.scss'
 
 /**
  * Subscript text for headings.
+ *
+ * _This component can only be accessed as a name-spaced component: `DisplayHeading.Sub`._
+ *
  */
 const DisplayHeadingSub = ({ children, ...rest }) => (
   <sub {...safeRest(rest)} className={styles.sub}>{children}</sub>

diff --git a/src/components/Typography/DisplayHeading/DisplayHeadingSup/DisplayHeadingSup.jsx b/src/components/Typography/DisplayHeading/DisplayHeadingSup/DisplayHeadingSup.jsx
@@ -6,6 +6,9 @@ import styles from '../DisplayHeading.modules.scss'
 
 /**
  * Superscript text for headings.
+ *
+ * _This component can only be accessed as a name-spaced component: `DisplayHeading.Sup`._
+ *
  */
 const DisplayHeadingSup = ({ children, ...rest }) => (
   <sup {...safeRest(rest)} className={styles.sup}>{children}</sup>

diff --git a/src/components/Typography/Heading/HeadingSub/HeadingSub.jsx b/src/components/Typography/Heading/HeadingSub/HeadingSub.jsx
@@ -6,6 +6,9 @@ import styles from '../Heading.modules.scss'
 
 /**
  * Subscript text for headings.
+ *
+ * _This component can only be accessed as a name-spaced component: `Heading.Sub`._
+ *
  */
 const HeadingSub = ({ children, ...rest }) => (
   <sub {...safeRest(rest)} className={styles.sub}>{children}</sub>

diff --git a/src/components/Typography/Heading/HeadingSup/HeadingSup.jsx b/src/components/Typography/Heading/HeadingSup/HeadingSup.jsx
@@ -6,6 +6,9 @@ import styles from '../Heading.modules.scss'
 
 /**
  * Superscript text for headings.
+ *
+ * _This component can only be accessed as a name-spaced component: `Heading.Sup`._
+ *
  */
 const HeadingSup = ({ children, ...rest }) => (
   <sup {...safeRest(rest)} className={styles.sup}>{children}</sup>

diff --git a/src/components/Typography/Text/TextSub/TextSub.jsx b/src/components/Typography/Text/TextSub/TextSub.jsx
@@ -8,6 +8,9 @@ import styles from '../Text.modules.scss'
 
 /**
  * Text that should be displayed lower than the main text (subscript).
+ *
+ * _This component can only be accessed as a name-spaced component: `Text.Sub`._
+ *
  */
 const TextSub = ({ children, ...rest }) => (
   <sub {...safeRest(rest)} className={styles.sub}>{children}</sub>

diff --git a/src/components/Typography/Text/TextSup/TextSup.jsx b/src/components/Typography/Text/TextSup/TextSup.jsx
@@ -7,6 +7,9 @@ import styles from '../Text.modules.scss'
 
 /**
  * Text that should be displayed higher than the main text (superscript).
+ *
+ * _This component can only be accessed as a name-spaced component: `Text.Sup`._
+ *
  */
 const TextSup = ({ children, ...rest }) => (
   <sup {...safeRest(rest)} className={styles.sup}>{children}</sup>