chore(docs): Changes to buttons and textInputs docs

Updated styled-components example in buttons and textInputs. Added private doc explaining why we use the statefulSelectors internal helper
styled-components · Dec 16, 2016 · e4bec7d · e4bec7d
1 parent deda26a
commit e4bec7d
Show file tree

Hide file tree

Showing 3 changed files with 6 additions and 2 deletions.
diff --git a/src/internalHelpers/_statefulSelectors.js b/src/internalHelpers/_statefulSelectors.js
@@ -9,6 +9,10 @@ type State =
   | null
   | string;
 
+/**
+ * Function helper that adds an array of states to a template of selectors. Used in textInputs and buttons.
+ * @private
+ */
 function statefulSelectors(states: Array<State>, template: Function, stateMap: ?Array<State>) {
   if (!template) throw new Error('You must provide a template to this method.')
   if (states.length === 0) return generateSelectors(template, null)

diff --git a/src/shorthands/buttons.js b/src/shorthands/buttons.js
@@ -29,7 +29,7 @@ type State =
  *
  * // styled-components usage
  * const div = styled.div`
- *   ${buttons('active')} {
+ *   > ${buttons('active')} {
  *     border: none;
  *   }
  * `

diff --git a/src/shorthands/textInputs.js b/src/shorthands/textInputs.js
@@ -41,7 +41,7 @@ type State =
  *
  * // styled-components usage
  * const div = styled.div`
- *   ${textInputs('active')} {
+ *   > ${textInputs('active')} {
  *     border: none;
  *   }
  * `