Added some inline documentation fixes

material/base.html

@@ -37,7 +37,7 @@
       {% include "partials/fonts.html" %}
     {% endblock %}
     {% block styles %}
-      <link rel="stylesheet" href="{{ base_url }}/assets/stylesheets/application-782a60368a.css">
+      <link rel="stylesheet" href="{{ base_url }}/assets/stylesheets/application-a2651bb338.css">
       {% if config.extra.palette %}
         <link rel="stylesheet" href="{{ base_url }}/assets/stylesheets/application-02ce7adcc2.palette.css">
       {% endif %}

src/assets/javascripts/application.js

@@ -44,7 +44,7 @@ export default class Application {
    */
   initialize() {
 
-    /* Initialize Modernizr and Fastclick */
+    /* Initialize Modernizr and FastClick */
     new Material.Event.Listener(document, "DOMContentLoaded", () => {
 
       /* Test for iOS */
@@ -60,7 +60,7 @@ export default class Application {
       /* Attack FastClick to mitigate 300ms delay on touch devices */
       FastClick.attach(document.body)
 
-      /* Wrap all data tables */
+      /* Wrap all data tables for better overflow scrolling */
       const tables = document.querySelectorAll("table:not([class])")
       Array.prototype.forEach.call(tables, table => {
         const wrap = document.createElement("div")
@@ -126,7 +126,7 @@ export default class Application {
           new Material.Nav.Collapse(collapse)))
     })
 
-    /* Component: pane monitor for iOS scrolling fixes */
+    /* Component: active pane monitor for iOS scrolling fixes */
     new Material.Event.MatchMedia("(max-width: 1219px)",
       new Material.Event.Listener(
         "[data-md-component=navigation] [data-md-toggle]", "change",
@@ -220,7 +220,7 @@ export default class Application {
       new Material.Event.Listener("[data-md-component=search]", "click",
         ev => ev.stopPropagation()))
 
-    /* Retrieve the facts for the given repository type */
+    /* Retrieve facts for the given repository type */
     ;(() => {
       const el = document.querySelector("[data-md-source]")
       if (!el) return Promise.resolve([])

src/assets/stylesheets/application.palette.scss

@@ -41,7 +41,7 @@
 // Rules
 // ----------------------------------------------------------------------------
 
-// Color tile
+// Color tile for presentation in theme documentation
 button[data-md-color-primary],
 button[data-md-color-accent] {
   width: 13rem;
@@ -85,7 +85,7 @@ button[data-md-color-accent] {
   "blue-grey":   $clr-blue-grey-600
 ) {
 
-  // Color tile for presentation                                                // TODO. comments
+  // Color tile for presentation in theme documentation
   button[data-md-color-primary="#{$name}"] {
     background-color: $color;
   }
@@ -158,7 +158,7 @@ button[data-md-color-accent] {
   "deep-orange": $clr-deep-orange-a200
 ) {
 
-  // Color tile for presentation
+  // Color tile for presentation in theme documentation
   button[data-md-color-accent="#{$name}"] {
     background-color: $color;
   }

src/assets/stylesheets/base/_icons.scss

@@ -46,18 +46,3 @@
     cursor: pointer;
   }
 }
-
-// Representational classes
-.md-icon {
-  @extend %md-icon;
-
-  // Build representational classes
-  @each $ligature, $name in (
-    "arrow_back": "back",
-    "arrow_forward": "forward"
-  ) {
-    &--#{$name}::before {
-      content: $ligature;
-    }
-  }
-}

src/assets/stylesheets/base/_reset.scss

@@ -24,7 +24,7 @@
 // Rules
 // ----------------------------------------------------------------------------
 
-// Enfore correct box model
+// Enforce correct box model
 html {
   box-sizing: border-box;
 }
@@ -77,7 +77,7 @@ a {
   }
 }
 
-// Correct font-size in all browsers
+// Normalize font-size in all browsers
 small {
   font-size: 80%;
 }
@@ -101,6 +101,7 @@ sup {
   top: -0.5em;
 }
 
+// Remove borders on images
 img {
   border-style: none;
 }

src/assets/stylesheets/base/_typeset.scss

@@ -66,7 +66,7 @@ kbd {
 // Content that is typeset - if possible, all margins, paddings and font sizes
 // should be set in ems, so nested blocks (e.g. Admonition) render correctly,
 // except headlines that should only appear on the top level and need to have
-// consistent spacing due to layout issues
+// consistent spacing due to layout constraints.
 .md-typeset {
   font-size: ms(0);
   line-height: 1.6;
@@ -149,7 +149,7 @@ kbd {
     color: $md-color-primary;
     word-break: break-word;
 
-    // Also enable transition on pseudo elements
+    // Also enable color transition on pseudo elements
     &,
     &::before {
       transition: color 0.125s;
@@ -161,10 +161,10 @@ kbd {
       color: $md-color-accent;
     }
 
-    // Add links for print
+    // Add URLs for print
     @media print {
 
-      // Show link reference
+      // Show link URL
       &::after {
         color: $md-color-black--light;
         content: " [" attr(href) "]";
@@ -254,7 +254,7 @@ kbd {
       }
     }
 
-    // Reset, if code is inside pre
+    // Reset, if code is wrapped inside pre tag
     > code {
       margin: 0;
       background-color: transparent;
@@ -298,7 +298,7 @@ kbd {
     cursor: help;
   }
 
-  // Smaller text
+  // Small text
   small {
     opacity: 0.75;
   }

src/assets/stylesheets/extensions/pymdown/_critic.scss

@@ -47,7 +47,7 @@
 
   // Addition
   ins.critic {
-    background-color: $codehilite-diff-inserted;
+    background-color: $codehilite-diff-inserted;                                // TODO: dependent on order of inclusion
     box-shadow:
       +0.25em 0 0 $codehilite-diff-inserted,
       -0.25em 0 0 $codehilite-diff-inserted;