From: Nicolas Coden <nicolas@ncoden.fr>
Date: Sat, 3 Feb 2018 23:07:39 +0000 (+0100)
Subject: docs: add some docs around `code` mixins
X-Git-Tag: v6.6.0~3^2~262^2
X-Git-Url: http://git.ipfire.org/cgi-bin/gitweb.cgi?a=commitdiff_plain;h=refs%2Fpull%2F10907%2Fhead;p=thirdparty%2Ffoundation%2Ffoundation-sites.git

docs: add some docs around `code` mixins
---

diff --git a/scss/typography/_helpers.scss b/scss/typography/_helpers.scss
index 57afb58f1..ce26b10b5 100644
--- a/scss/typography/_helpers.scss
+++ b/scss/typography/_helpers.scss
@@ -92,6 +92,8 @@ $code-block-margin-bottom: 1.5rem !default;
   }
 }
 
+/// Add basic styles for a code helper.
+/// See `code-inline` and `code-block` mixins.
 @mixin code-style {
   border: $code-border;
   background-color: $code-background;
@@ -101,6 +103,8 @@ $code-block-margin-bottom: 1.5rem !default;
   color: $code-color;
 }
 
+/// Make code helper from the `code-style` mixin inline.
+/// Used to generate `.code-inline`
 @mixin code-inline {
   display: inline;
   max-width: 100%;
@@ -109,6 +113,8 @@ $code-block-margin-bottom: 1.5rem !default;
   padding: $code-padding;
 }
 
+/// Make code helper from the `code-style` mixin a block.
+/// Used to generate `.code-block`
 @mixin code-block {
   display: block;
   overflow: auto;