docs(typography): Aligned children prop documentation for all typogra…

…phy components
telus · Sep 6, 2017 · bcf10ed · bcf10ed
1 parent e64a145
commit bcf10ed
Show file tree

Hide file tree

Showing 10 changed files with 14 additions and 8 deletions.
diff --git a/src/components/Typography/DisplayHeading/DisplayHeading.jsx b/src/components/Typography/DisplayHeading/DisplayHeading.jsx
@@ -26,7 +26,7 @@ DisplayHeading.propTypes = {
    */
   invert: PropTypes.bool,
   /**
-   * The heading text.
+   * The text.
    */
   children: PropTypes.node.isRequired
 }

diff --git a/src/components/Typography/DisplayHeading/DisplayHeadingSub/DisplayHeadingSub.jsx b/src/components/Typography/DisplayHeading/DisplayHeadingSub/DisplayHeadingSub.jsx
@@ -15,6 +15,9 @@ const DisplayHeadingSub = ({ children, ...rest }) => (
 )
 
 DisplayHeadingSub.propTypes = {
+  /**
+   * The text.
+   */
   children: PropTypes.string.isRequired
 }
 

diff --git a/src/components/Typography/DisplayHeading/DisplayHeadingSup/DisplayHeadingSup.jsx b/src/components/Typography/DisplayHeading/DisplayHeadingSup/DisplayHeadingSup.jsx
@@ -18,7 +18,7 @@ const DisplayHeadingSup = ({ children, ...rest }) => (
 
 DisplayHeadingSup.propTypes = {
   /**
-   * The text
+   * The text.
    */
   children: PropTypes.string.isRequired
 }

diff --git a/src/components/Typography/Heading/Heading.jsx b/src/components/Typography/Heading/Heading.jsx
@@ -44,7 +44,7 @@ Heading.propTypes = {
    */
   invert: PropTypes.bool,
   /**
-   * The heading text.
+   * The text.
    */
   children: PropTypes.node.isRequired
 }

diff --git a/src/components/Typography/Heading/HeadingSub/HeadingSub.jsx b/src/components/Typography/Heading/HeadingSub/HeadingSub.jsx
@@ -15,6 +15,9 @@ const HeadingSub = ({ children, ...rest }) => (
 )
 
 HeadingSub.propTypes = {
+  /**
+   * The text.
+   */
   children: PropTypes.string.isRequired
 }
 

diff --git a/src/components/Typography/Heading/HeadingSup/HeadingSup.jsx b/src/components/Typography/Heading/HeadingSup/HeadingSup.jsx
@@ -18,7 +18,7 @@ const HeadingSup = ({ children, ...rest }) => (
 
 HeadingSup.propTypes = {
   /**
-   * The text
+   * The text.
    */
   children: PropTypes.string.isRequired
 }

diff --git a/src/components/Typography/Small/Small.jsx b/src/components/Typography/Small/Small.jsx
@@ -18,7 +18,7 @@ const Small = ({ children, ...rest }) => (
 
 Small.propTypes = {
   /**
-   * The Text
+   * The text.
    */
   children: PropTypes.string.isRequired
 }

diff --git a/src/components/Typography/Strong/Strong.jsx b/src/components/Typography/Strong/Strong.jsx
@@ -18,7 +18,7 @@ const Strong = ({ children, ...rest }) => (
 
 Strong.propTypes = {
   /**
-   * The text
+   * The text.
    */
   children: PropTypes.string.isRequired
 }

diff --git a/src/components/Typography/Text/Text.jsx b/src/components/Typography/Text/Text.jsx
@@ -45,7 +45,7 @@ Text.propTypes = {
    */
   invert: PropTypes.bool,
   /**
-   * Text
+   * The text.
    */
   children: PropTypes.node.isRequired
 }

diff --git a/src/components/Typography/Text/TextSup/TextSup.jsx b/src/components/Typography/Text/TextSup/TextSup.jsx
@@ -19,7 +19,7 @@ const TextSup = ({ children, ...rest }) => (
 
 TextSup.propTypes = {
   /**
-   * Text
+   * The text.
    */
   children: PropTypes.node.isRequired
 }