Add example to Bourbon user settings

johnnybridges · Mar 31, 2016 · 0dc60e9 · 0dc60e9
1 parent 14fda38
commit 0dc60e9
Showing 1 changed file with 11 additions and 1 deletion.
diff --git a/core/bourbon/settings/_settings.scss b/core/bourbon/settings/_settings.scss
@@ -34,8 +34,18 @@ $_bourbon-defaults: (
   "rails-asset-pipeline": false,
 );
 
-/// User overrides of Bourbon configuration settings
+/// User overrides of Bourbon configuration settings.
 ///
 /// @type map
+///
+/// @example scss
+///   $bourbon: (
+///     "contrast-switch-dark-color": #000,
+///     "contrast-switch-light-color": #fff,
+///     "global-font-file-formats": ("ttf", "woff2", "woff"),
+///     "modular-scale-base": 1em,
+///     "modular-scale-ratio": $major-third,
+///     "rails-asset-pipeline": false,
+///   );
 
 $bourbon: () !default;