From 5ebc1f2a5420cf8a676ea04e0be12e0aadf30d79 Mon Sep 17 00:00:00 2001
From: Nicolas Coden <nicolas@ncoden.fr>
Date: Sun, 4 Feb 2018 00:07:39 +0100
Subject: [PATCH] docs: add some docs around `code` mixins

---
 scss/typography/_helpers.scss | 6 ++++++
 1 file changed, 6 insertions(+)

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;
-- 
2.47.2