flint-gs 1.3.5 → 1.3.6

data/stylesheets/flint/functions/lib/_calc-breakpoint.scss

@@ -2,35 +2,38 @@
 // -------------------------------------------------------------------------------
 // @dependence `map-fetch()`
 // @dependence `get-value()`
+// @dependence `steal-key()`
+// @dependence `is-highest-breakpoint()`
+// @dependence `is-lowest-breakpoint()`
 // -------------------------------------------------------------------------------
-// @param $n ["alias" | "prev" | "next"] : how to calculate breakpoint 
-// @param $key [Value] : key of breakpoint
-// @param $i [Value] : index of current breakpoint
+// @param $n [string] : how to calculate breakpoint 
+// @param $key [string] : key of breakpoint
+// @param $i [integer] : index of current breakpoint
 // -------------------------------------------------------------------------------
-// @return [Value]
+// @return calculated value
 
 @function calc-breakpoint($n, $key, $i) {
     @if $n == "alias" {
-        @if get-value(settings, grid) == "fixed" {
+        @if get-value("settings", "grid") == "fixed" {
             @if is-lowest-breakpoint($key) {
                 @return 0;
             } @else {
-                @return get-value($key, breakpoint);
+                @return get-value($key, "breakpoint");
             }
-        } @else if get-value(settings, grid) == "fluid" {
-            @return get-value($key, breakpoint);
+        } @else if get-value("settings", "grid") == "fluid" {
+            @return get-value($key, "breakpoint");
         }
     } @else if $n == "next" {
         @if is-lowest-breakpoint($key) {
             @return 0;
         } @else {
-            @return get-value(steal-key(($i + 1)), breakpoint);
+            @return get-value(steal-key(($i + 1)), "breakpoint");
         }
     } @else if $n == "prev" {
         @if is-highest-breakpoint($key) {
-            @return get-value($key, breakpoint);
+            @return get-value($key, "breakpoint");
         } @else {
-            @return get-value(steal-key(($i - 1)), breakpoint);
+            @return get-value(steal-key(($i - 1)), "breakpoint");
         }
     }
 }

data/stylesheets/flint/functions/lib/_calc-margin.scss

@@ -3,28 +3,28 @@
 // @dependence `get-value()`
 // @dependence `fluid-width()`
 // -------------------------------------------------------------------------------
-// @param $key [Breakpoint | "container"] : key for lookup
-// @param $span [Value] : span of element
-// @param $context [Value] : context of element
+// @param $key [string] : key for lookup
+// @param $span [integer] : span value of element
+// @param $context [integer] : context value of element
 // -------------------------------------------------------------------------------
-// @return [Value] | false
+// @return calculated value | false
 
-@function calc-margin($key, $span, $context: NULL) {
-	@if get-value(settings, grid) == "fluid" {
+@function calc-margin($key, $span, $context: null) {
+	@if get-value("settings", "grid") == "fluid" {
 		@if $key == "container" or $span == "container" {
 			@return 0;
-		} @else if $context == NULL {
-			@return fluid-width(get-value(settings, gutter), get-value($key, breakpoint));
-		} @else if $context <= get-value($key, columns) {
-			@return fluid-width(get-value(settings, gutter), ((get-value($key, breakpoint) / get-value($key, columns) * $context)));
+		} @else if $context == null {
+			@return fluid-width(get-value("settings", "gutter"), get-value($key, "breakpoint"));
+		} @else if $context <= get-value($key, "columns") {
+			@return fluid-width(get-value("settings", "gutter"), ((get-value($key, "breakpoint") / get-value($key, "columns") * $context)));
 		} @else {
-			@return fluid-width(get-value(settings, gutter) / get-value($key, columns) * $context, ((get-value($key, breakpoint) / get-value($key, columns) * $context)));
+			@return fluid-width(get-value("settings", "gutter") / get-value($key, "columns") * $context, ((get-value($key, "breakpoint") / get-value($key, "columns") * $context)));
 		}
-	} @if get-value(settings, grid) == "fixed" {
+	} @if get-value("settings", "grid") == "fixed" {
 		@if $key == "container" or $span == "container" {
 			@return 0;
 		} @else {
-			@return get-value(settings, gutter);
+			@return get-value("settings", "gutter");
 		}
 	} @else {
 		@return false;

data/stylesheets/flint/functions/lib/_calc-width.scss

@@ -3,26 +3,26 @@
 // @dependence `get-value()`
 // @dependence `fluid-width()`
 // -------------------------------------------------------------------------------
-// @param $key [Breakpoint | "container"] : how to calculate value 
-// @param $span [Value] : span
-// @param $context [Value] : if context is needed
+// @param $key [string] : key for lookup
+// @param $span [integer] : span value of element
+// @param $context [integer] : context value of element
 // -------------------------------------------------------------------------------
-// @return [Value] | false
+// @return calculated value | false
 
-@function calc-width($key, $span, $context: NULL) {
-	@if get-value(settings, grid) == "fluid" {
+@function calc-width($key, $span, $context: null) {
+	@if get-value("settings", "grid") == "fluid" {
 		@if $key == "container" or $span == "container" {
-			@return fluid-width(get-value($key, breakpoint), get-value($key, breakpoint));
-		} @else if $context == NULL {
-			@return fluid-width((get-value($key, breakpoint) / get-value($key, columns) * $span), get-value($key, breakpoint));
+			@return fluid-width(get-value($key, "breakpoint"), get-value($key, "breakpoint"));
+		} @else if $context == null {
+			@return fluid-width((get-value($key, "breakpoint") / get-value($key, "columns") * $span), get-value($key, "breakpoint"));
 		} @else {
-			@return fluid-width((get-value($key, breakpoint) / get-value($key, columns) * $span), ((get-value($key, breakpoint) / get-value($key, columns) * $context)));
+			@return fluid-width((get-value($key, "breakpoint") / get-value($key, "columns") * $span), ((get-value($key, "breakpoint") / get-value($key, "columns") * $context)));
 		}
-	} @if get-value(settings, grid) == "fixed" {
+	} @if get-value("settings", "grid") == "fixed" {
 		@if $key == "container" or $span == "container" {
-			@return get-value($key, breakpoint);
+			@return get-value($key, "breakpoint");
 		} @else {
-			@return get-value($key, breakpoint) / get-value($key, columns) * $span;
+			@return get-value($key, "breakpoint") / get-value($key, "columns") * $span;
 		}
 	} @else {
 		@return false;

data/stylesheets/flint/functions/lib/_exists.scss

@@ -1,9 +1,9 @@
 // Check if key exists in map
 //--------------------------------------------------------------------------------
-// @param $map [Map] : map that contains $value
-// @param $value [Map] : key to search for
+// @param $map [map] : map that contains $value
+// @param $value [string] : key to search for
 // -------------------------------------------------------------------------------
-// @return [Boolean]
+// @return [bool]
 
 @function exists($map, $value){
 	

data/stylesheets/flint/functions/lib/_fluid-width.scss

@@ -1,9 +1,9 @@
 // Convert fixed to fluid width
 //--------------------------------------------------------------------------------
-// @param $target [Value] : target
-// @param $context [Value] : context
+// @param $target [integer] : target
+// @param $context [integer] : context
 // -------------------------------------------------------------------------------
-// @return [Value]
+// @return [integer]
 
 @function fluid-width($target, $context) {
 	@return ($target / $context) * 100%;

data/stylesheets/flint/functions/lib/_get-family-instance.scss

@@ -7,11 +7,11 @@
 // @dependence `exists()`
 // @dependence `remove()`
 // -------------------------------------------------------------------------------
-// @param $key [Breakpoint] : breakpoint key to search for matching instance
+// @param $key [string] : breakpoint key to search for matching instance
 // -------------------------------------------------------------------------------
-// @return [Selectors] | false
+// @return matching instance | false
 
-@function get-family-instance($key: get-value(settings, default)) {
+@function get-family-instance($key: get-value("settings", "default")) {
 	$selector-string: selector_string();
 	$selector-list: string-to-list($selector-string);
 	$length: length($selector-list);

data/stylesheets/flint/functions/lib/_get-index.scss

@@ -2,12 +2,12 @@
 // -------------------------------------------------------------------------------
 // @dependence `steal-key()`
 // -------------------------------------------------------------------------------
-// @param $key [Breakpoint] : breakpoint key
+// @param $key [string] : breakpoint key
 // -------------------------------------------------------------------------------
-// @return [Value]
+// @return [integer]
 
 @function get-index($key) {
-  	@for $i from 1 through (length(map-fetch($flint, config)) - 1) {
+  	@for $i from 1 through (length(map-fetch($flint, "config")) - 1) {
 		@if steal-key($i) == $key {
 			@return $i;
 		}

data/stylesheets/flint/functions/lib/_get-instance-value.scss

@@ -2,16 +2,16 @@
 // -------------------------------------------------------------------------------
 // @dependence `map-fetch()`
 // -------------------------------------------------------------------------------
-// @warning : all [Values] @returned are strings and must be converted with `to-number()`
+// @warning : all values @returned are strings and must be converted with `to-number()`
 // -------------------------------------------------------------------------------
-// @param $key [Breakpoint] : key
-// @param $value [Value] : value
-// @param $deep [Value] : fetch deep value
+// @param $key [string] : key
+// @param $value [integer] : value
+// @param $deep [integer] : fetch deep value
 // -------------------------------------------------------------------------------
-// @return [Value]
+// @return [string]
 
-@function get-instance-value($key, $value, $deep: NULL) {
-	@if $deep == NULL {
+@function get-instance-value($key, $value, $deep: null) {
+	@if $deep == null {
 		@return map-fetch($flint__instances, get-family-instance($key) $value);
 	} @else {
 		@return map-fetch($flint__instances, get-family-instance($key) $value $deep);

data/stylesheets/flint/functions/lib/_get-substring.scss

@@ -2,10 +2,10 @@
 // -------------------------------------------------------------------------------
 // @dependence `string-to-list()`
 // -------------------------------------------------------------------------------
-// @param $full-string [String] : string that contains substring
-// @param $depth [Integer | "last | "first"] : depth of substring
+// @param $full-string [string] : string that contains substring
+// @param $depth [integer | string] : depth of substring
 // -------------------------------------------------------------------------------
-// @return [String]
+// @return [string]
 
 @function get-substring($full-string, $depth) {
 	@if is-string($full-string) {

data/stylesheets/flint/functions/lib/_get-value.scss

@@ -2,15 +2,15 @@
 // -------------------------------------------------------------------------------
 // @dependence `map-fetch()`
 // -------------------------------------------------------------------------------
-// @param $key [Value] : breakpoint key
-// @param $value [Value] : fetch value
+// @param $key [string] : breakpoint key
+// @param $value [string] : fetch value
 // -------------------------------------------------------------------------------
-// @return [Value]
+// @return fetched value
 
-@function get-value($key, $value: NULL) {
-	@if $value == NULL {
-		@return map-fetch($flint, config $key);
+@function get-value($key, $value: null) {
+	@if $value == null {
+		@return map-fetch($flint, "config" $key);
 	} @else {
-		@return map-fetch($flint, config $key $value);
+		@return map-fetch($flint, "config" $key $value);
 	}
 }

data/stylesheets/flint/functions/lib/_instance.scss

@@ -2,16 +2,16 @@
 // -------------------------------------------------------------------------------
 // @dependence `get-value()`
 // -------------------------------------------------------------------------------
-// @param $key [Breakpoint] : computed breakpoint of instance
-// @param $span [Value] : computed span of instance
-// @param $context [Value] : computed context of instance
-// @param $gutter [Value] : computed gutter of instance
-// @param $shift [Value] : computed shift of instance
-// @param $outputWidth [Value] : computed width of instance
-// @param $outputMarginRight [Value] : computed right margin of instance
-// @param $outputMarginLeft [Value] : computed left margin of instance
+// @param $key [string] : computed breakpoint of instance
+// @param $span [integer] : computed span of instance
+// @param $context [integer] : computed context of instance
+// @param $gutter [integer] : computed gutter of instance
+// @param $shift [integer] : computed shift of instance
+// @param $outputWidth [integer] : computed width of instance
+// @param $outputMarginRight [integer] : computed right margin of instance
+// @param $outputMarginLeft [integer] : computed left margin of instance
 // -------------------------------------------------------------------------------
-// @return [Value] | map
+// @return instance map
 
 @function instance($key, $span, $context, $gutter, $shift, $outputWidth, $outputMarginRight, $outputMarginLeft) {
 	  // Increase the instance count
@@ -29,7 +29,7 @@
 			"breakpoint": #{get-value($key, breakpoint)},
 			"columns": #{get-value($key, columns)},
 			"span": #{$span},
-			"context": #{if($context == "auto", get-instance-value($key, span), $context)},
+			"context": #{if($context == "auto", get-instance-value($key, "span"), $context)},
 			"gutter": #{$gutter},
 			"shift": #{$shift},
 			"output": (

data/stylesheets/flint/functions/lib/_last.scss

@@ -1,8 +1,8 @@
 // Get last item in list
 // -------------------------------------------------------------------------------
-// @param $list [List] : list
+// @param $list [list] : list
 // -------------------------------------------------------------------------------
-// @return [List]
+// @return [list]
 
 @function last($list) {
 	@return nth($list, length($list));

data/stylesheets/flint/functions/lib/_list-to-string.scss

@@ -2,10 +2,10 @@
 // -------------------------------------------------------------------------------
 // @documentation http://sassylists.com/documentation/#to-string
 // -------------------------------------------------------------------------------
-// @param $list [List] : list
-// @param $glue [String] : value to use as a join string
+// @param $list [list] : list
+// @param $glue [string] : value to use as a join string
 // -------------------------------------------------------------------------------
-// @return [String]
+// @return [string]
 
 @function list-to-string($list, $glue: "", $is-nested: false) {
 	$result: null;

data/stylesheets/flint/functions/lib/_map-fetch.scss

@@ -2,19 +2,18 @@
 // -------------------------------------------------------------------------------
 // @dependence `map-fetche()`
 // -------------------------------------------------------------------------------
-// @param $i [Map] : map
-// @param $n [Keys...] : keys
+// @param $i [map] : map
+// @param $n [list] : keys
 // -------------------------------------------------------------------------------
-// @return [Value] | false
+// @return fetched value | false
 
 @function map-fetch($map, $keys) {
 	$key: nth($keys, 1);
 	$length: length($keys);
 	$value: map-get($map, $key);
 
-	// check if value equals NULL (meaning the @param was incorrect and the map doesn't exist)
-
-	@if $value == NULL {
+	// check if value equals null (meaning the @param was incorrect and the map doesn't exist)
+	@if $value == null {
 		@warn "Invalid arguments padded to function: `map-fetch(#{$map}, #{$keys})`";
 		@return false;
 	}

data/stylesheets/flint/functions/lib/_next-index.scss

@@ -1,15 +1,15 @@
-// Returns next indexed key based on passed number
+// Returns next indexed key based on passed index
 // -------------------------------------------------------------------------------
-// @param $index [Value] : index
+// @param $index [integer] : index
 // -------------------------------------------------------------------------------
-// @return [Key] | NULL
+// @return [string] | null
 
 @function next-index($index) { 
-	@if $index != (length(map-fetch($flint, config)) - 1) {
-		@each $key in nth(map-get($flint, config), $index + 1) {
+	@if $index != (length(map-fetch($flint, "config")) - 1) {
+		@each $key in nth(map-get($flint, "config"), $index + 1) {
 			@return $key;
 		}
 	} @else {
-		@return NULL;
+		@return null;
 	}
 }

data/stylesheets/flint/functions/lib/_purge.scss

@@ -4,9 +4,9 @@
 // -------------------------------------------------------------------------------
 // @dependence `is-true()`
 // -------------------------------------------------------------------------------
-// @param $list [List] : list
+// @param $list [list] : list
 // -------------------------------------------------------------------------------
-// @return [List]
+// @return [list]
 
 @function purge($list) {
 	$result: ();

data/stylesheets/flint/functions/lib/_remove.scss

@@ -4,11 +4,11 @@
 // -------------------------------------------------------------------------------
 // @dependence `replace()`
 // -------------------------------------------------------------------------------
-// @param $list [List] : list
-// @param $value [Literal] : value to remove
-// @param $recursive [Boolean] : enable / disable recursivity
+// @param $list [list] : list
+// @param $value [literal] : value to remove
+// @param $recursive [bool] : enable / disable recursivity
 // -------------------------------------------------------------------------------
-// @return [List]
+// @return [list]
 
 @function remove($list, $value) {
 	@return replace($list, $value, null);

data/stylesheets/flint/functions/lib/_replace.scss

@@ -2,11 +2,11 @@
 // -------------------------------------------------------------------------------
 // @documentation http://sassylists.com/documentation.html#replace
 // -------------------------------------------------------------------------------
-// @param $list [List] : list
-// @param $old [Literal] : value to replace
-// @param $value [Literal] : new value for $old
+// @param $list [list] : list
+// @param $old [literal] : value to replace
+// @param $value [literal] : new value for $old
 // -------------------------------------------------------------------------------
-// @return [List]
+// @return [list]
 
 @function replace($list, $old, $value) {
   $running: true;

data/stylesheets/flint/functions/lib/_steal-key.scss

@@ -1,12 +1,12 @@
 // Steal key based on index number
 //--------------------------------------------------------------------------------
-// @param $index [Integer] : index of key
+// @param $index [integer] : index of key
 // -------------------------------------------------------------------------------
-// @return [Breakpoint]
+// @return [string]
 
 @function steal-key($index) {
-	@for $n from 1 through (length(map-fetch($flint, config)) - 1) {
-		@each $key in nth(map-get($flint, config), $index) {
+	@for $n from 1 through (length(map-fetch($flint, "config")) - 1) {
+		@each $key in nth(map-get($flint, "config"), $index) {
 			@return $key;
 		}
 	}

data/stylesheets/flint/functions/lib/_steal-values.scss

@@ -3,10 +3,10 @@
 // @dependence `map-fetch()`
 // @dependence `get-value()`
 // -------------------------------------------------------------------------------
-// @param $index [Value] : index of breakpoint key in config
-// @param $value [Value] : value
+// @param $index [integer] : index of breakpoint key in config
+// @param $value [integer] : value
 // -------------------------------------------------------------------------------
-// @return [Value]
+// @return [integer]
 
 @function steal-values($index, $value) {
 	@for $n from 1 through (length(map-fetch($flint, config)) - 1) {