docs(divider): Initial docs

telus · Sep 26, 2017 · c0d2af7 · c0d2af7
1 parent 5b2f899
commit c0d2af7
Show file tree

Hide file tree

Showing 2 changed files with 5 additions and 0 deletions.
diff --git a/src/components/Dividers/WaveDivider/WaveDivider.jsx b/src/components/Dividers/WaveDivider/WaveDivider.jsx
@@ -5,6 +5,9 @@ import safeRest from '../../../utils/safeRest'
 import wave from './wave.svg'
 import styles from './WaveDivider.modules.scss'
 
+/**
+ * Divide page content blocks.
+ */
 const WaveDivider = ({ ...rest }) => (
   <img {...safeRest(rest)} src={wave} alt="" className={styles.wave} />
 )

diff --git a/src/components/Dividers/WaveDivider/WaveDivider.md b/src/components/Dividers/WaveDivider/WaveDivider.md
@@ -1,3 +1,5 @@
+There should be at most 1 `WaveDivider` per page.
+
 ```
 <WaveDivider />
 ```