Clean up comments in Sass partials

tklengyel · Feb 8, 2015 · dd7067b · dd7067b
1 parent f6c6028
commit dd7067b
Show file tree

Hide file tree

Showing 9 changed files with 480 additions and 211 deletions.
diff --git a/_sass/coderay.scss b/_sass/coderay.scss
@@ -1,3 +1,7 @@
+/* ==========================================================================
+   Coderay syntax highlighting
+   ========================================================================== */
+
 .CodeRay {
   background-color: #efefef;
   font-family: $code-font;
@@ -130,4 +134,4 @@ ol.CodeRay li { white-space: pre }
 .CodeRay .insert .insert { color: #080; font-weight:bold }
 .CodeRay .delete .delete { color: #800; font-weight:bold }
 .CodeRay .change .change { color: #66f; }
-.CodeRay .head .head { color: #f4f; }
+.CodeRay .head .head { color: #f4f; }
diff --git a/_sass/elements.scss b/_sass/elements.scss
@@ -1,3 +1,7 @@
+/* 
+   Rules
+   ========================================================================== */
+
 hr { 
 	display: block; 
 	margin: 1em 0; 
@@ -7,20 +11,29 @@ hr {
 	border-top: 1px solid #ccc;
 	border-bottom: 1px solid #fff; 
 }
-/* Figures and images ==================================== */
+
+/* 
+   Figures and images
+   ========================================================================== */
+
 figure {
 	margin-bottom: $indent-var;
 }
+
 article img {
 	max-width: 100%;
 	height: auto;
 	border-width: 0; 
 	vertical-align: middle; 
 	-ms-interpolation-mode: bicubic; 
 }
+
 svg:not(:root) {
 		overflow: hidden; 
 }
+
+/* 2 images of equal dimensions in a row */
+
 .half {
 	@include container;
 	@include clearfix;
@@ -33,6 +46,9 @@ svg:not(:root) {
 		}
 	}
 }
+
+/* 3 images of equal dimensions in a row */
+
 .third {
 	@include container;
 	@include clearfix;
@@ -45,7 +61,13 @@ svg:not(:root) {
 		}
 	}
 }
-/* Buttons ============================================== */
+
+/* 
+   Buttons
+   ========================================================================== */
+
+/* Default button */
+
 .btn {
   display: inline-block;
   margin-bottom: 20px;
@@ -68,6 +90,9 @@ svg:not(:root) {
     color: $primary;
   }
 }
+
+/* Success button */
+
 .btn-success {
   background-color: $success;
   color: $white;
@@ -80,6 +105,9 @@ svg:not(:root) {
     color: $success;
   }
 }
+
+/* Warning button */
+
 .btn-warning {
   background-color: $warning;
   color: $white;
@@ -92,6 +120,9 @@ svg:not(:root) {
     color: $warning;
   }
 }
+
+/* Danger button */
+
 .btn-danger {
   background-color: $danger;
   color: $white;
@@ -104,6 +135,9 @@ svg:not(:root) {
     color: $danger;
   }
 }
+
+/* Information button */
+
 .btn-info {
   background-color: $info;
   color: $white;
@@ -116,7 +150,11 @@ svg:not(:root) {
     color: $info;
   }
 }
-/* Well ================================================= */
+
+/* 
+   Wells
+   ========================================================================== */
+
 .well {
 	min-height: 20px;
 	padding: 19px;

diff --git a/_sass/forms.scss b/_sass/forms.scss
@@ -1,3 +1,7 @@
+/* ==========================================================================
+   Forms
+   ========================================================================== */
+
 btnform { 
 	margin: 0 0 5px 0;
 	fieldset { 
@@ -158,7 +162,11 @@ input[type="hidden"] {
 .checkbox.inline + .checkbox.inline {
 	margin-left : 10px; 
 }
-/* disabled ==================================== */
+
+/* 
+   Disabled state
+   ========================================================================== */
+
 input[disabled],
 select[disabled],
 textarea[disabled],
@@ -168,7 +176,11 @@ textarea[readonly] {
 	@include opacity(.5);
 	cursor : not-allowed; 
 }
-/* focus and active ============================ */
+
+/* 
+   Focus & active state
+   ========================================================================== */
+
 input:focus,
 textarea:focus {
 	border-color : $accentcolor;
@@ -181,7 +193,11 @@ input[type="checkbox"]:focus,
 select:focus {
 	@include box-shadow(none); 
 }
-/* help text ==================================== */
+
+/* 
+   Help text
+   ========================================================================== */
+
 .help-block,
 .help-inline {
 	color : lighten($black, 50); 
@@ -196,7 +212,11 @@ select:focus {
 	vertical-align : middle;
 	padding-left : 5px; 
 }
-/* .form-inline ================================= */
+
+/* 
+   .form-inline
+   ========================================================================== */
+
 .form-inline input,
 .form-inline textarea,
 .form-inline select {
@@ -218,7 +238,11 @@ select:focus {
 	float : left;
 	margin-left : 0;
 	margin-right : 3px; }
-/* .form-search ================================= */
+
+/* 
+   .form-search
+   ========================================================================== */
+
 .form-search input,
 .form-search textarea,
 .form-search select {
@@ -246,4 +270,4 @@ select:focus {
 	float : left;
 	margin-left : 0;
 	margin-right : 3px;
-}
+}
diff --git a/_sass/grid.scss b/_sass/grid.scss
@@ -1,5 +1,12 @@
-// Defining number of columns in the grid.
-// Common Values would be 12, 16 or 24
+/* ==========================================================================
+   Grid mixins
+   ========================================================================== */
+
+/* 
+   Define number of columns in the grid
+   Common values would be 12, 16 or 24
+   ========================================================================== */
+
 $width: 100%;
 $def_grid: 12;
 $margin: 0;
@@ -8,40 +15,70 @@ $margin: 0;
   margin:0 auto;
   width:$width;
 }
-
-// Works out the width of elements based
-// on total number of columns and width
-// number of columns being displayed.
-// Removes 20px for margins
+
+/* 
+   Works out the width of elements based on total number of columns and width
+   number of columns being displayed. Removes 20px for margins.
+   ========================================================================== */
+
 @mixin grid($grid:$def_grid,$cols:'',$float:left,$display:inline){
   display:$display;
   float:$float;
   width:(100%/$grid * $cols) - ($margin * 2);
 }  
 
-// Allows for padding before element
+/* 
+   Add x amount of column padding before an element
+   Example: @include prefix(1,12);
+   ========================================================================== */
+
 @mixin prefix($grid:$def_grid,$cols:''){
   margin-left:(100%/$grid * $cols);
 }
-// Allows for padding after element
+
+/* 
+   Add x amount of column padding after an element
+   Example: @include suffix(2,12);
+   ========================================================================== */
+
 @mixin suffix($grid:$def_grid,$cols:''){  
   margin-right:(100%/$grid * $cols);    
 }
-// Removes left margin
+
+/* 
+   Remove left margin
+   Example: @include first;
+   ========================================================================== */
+
 @mixin first(){
   margin-left:0;
 }
-// Removes right margin
+
+/* 
+   Remove right margin
+   Example: @include last;
+   ========================================================================== */
+
 @mixin last(){
   margin-right:0;
 }
 
+/* 
+   Push an element x amount of column(s) to the right
+   Example: @include push(2,12);
+   ========================================================================== */
+
 @mixin push($grid:$def_grid,$move:'') {
   position:relative;
   left:(100%/$grid * $move);
 } 
 
+/* 
+   Pull an element x amount of column(s) to the left
+   Example: @include pull(1,12);
+   ========================================================================== */
+
 @mixin pull($grid:$def_grid,$move:''){
   position:relative;
   left:(100%/$grid * $move) * -1;
-}
+}