SassyLists 1.0.0 → 1.1.0

data/stylesheets/SassyLists/_flatten.scss

@@ -1,37 +1,36 @@
-// Turns multidimensional $list into a one-level list
-// -------------------------------------------------------------------------------
-// @documentation http://sassylists.com/documentation.html#flatten
-// -------------------------------------------------------------------------------
-// @alias `unfold()`
-// -------------------------------------------------------------------------------
-// @param $list [List] : list
-// -------------------------------------------------------------------------------
-// @return [List]
-
-@function flatten($list) {
-  $result: ();
-
-  @if length($list) == 1 {
-    @return $list;
-  }
-
-  @each $item in $list {
-    @if length($item) > 1 {
-      $flatten: flatten($item);
-      @each $i in $flatten {
-        $result: append($result, $i, list-separator($list));
-      }
-    }
-
-    @else {
-      $result: append($result, $item, list-separator($list));
-    }
-  }
-
-  @return $result;
-}
-
-// Alias
-@function unfold($list) {
-    @return flatten($list);
+// Turns multidimensional $list into a one-level list
+//
+// @ignore Documentation: http://sassylists.com/documentation.html#flatten
+//
+// @param {List} $list - list to flatten
+//
+// @return {List}
+
+@function flatten($list) {
+  $result: ();
+
+  @if length($list) == 1 {
+    @return $list;
+  }
+
+  @each $item in $list {
+    @if length($item) > 1 {
+      $flatten: flatten($item);
+      @each $i in $flatten {
+        $result: append($result, $i, list-separator($list));
+      }
+    }
+
+    @else {
+      $result: append($result, $item, list-separator($list));
+    }
+  }
+
+  @return $result;
+}
+
+// @alias flatten
+
+@function unfold($list) {
+    @return flatten($list);
 }

data/stylesheets/SassyLists/_insert-nth.scss

@@ -1,45 +1,46 @@
-// Adds $value at $index in $list
-// -------------------------------------------------------------------------------
-// @documentation http://sassylists.com/documentation/#insert-nth
-// -------------------------------------------------------------------------------
-// @param $list [List] : list
-// @param $index [Number] : index to add
-// @param $value [Literal] : value to add
-// -------------------------------------------------------------------------------
-// @raise [Error] if $index isn't an integer
-// @raise [Error] if $index is strictly lesser than 1
-// @raise [Error] if $index is strictly greater than length of $list
-// -------------------------------------------------------------------------------
-// @return [List] | false
-
-@function insert-nth($list, $index, $value) {
-  $length: length($list);
-
-  @if type-of($index) != number {
-    @warn "List index #{$index} is not a number for `insert-nth`.";
-    @return false;
-  }
-
-  @if $index < 1 {
-    @warn "List index #{$index} must be a non-zero integer for `insert-nth`";
-    @return false;
-  }
-
-  @if $index > $length {
-    @return append($list, $value, list-separator($list));
-  }
-
-  $result: ();
-
-  @for $i from 1 through $length {
-    @if $i == $index {
-      @if is-true($value) {
-        $result: append($result, $value, list-separator($list));
-      }
-    }
-
-    $result: append($result, nth($list, $i), list-separator($list));
-  }
-
-  @return $result;
-}
+// Adds $value at $index in $list
+//
+// @ignore Documentation: http://sassylists.com/documentation/#insert-nth
+//
+// @requires is-true
+//
+// @param {List}    $list  - list to update
+// @param {Number}  $index - index to add
+// @param {*}       $value - value to add
+//
+// @throws List index $index is not a number for `insert-nth`.
+// @throws List index $index must be a non-zero integer for `insert-nth`.
+//
+// @return {List | Bool}
+
+@function insert-nth($list, $index, $value) {
+  $length: length($list);
+
+  @if type-of($index) != number {
+    @warn "List index #{$index} is not a number for `insert-nth`.";
+    @return false;
+  }
+
+  @if $index < 1 {
+    @warn "List index #{$index} must be a non-zero integer for `insert-nth`.";
+    @return false;
+  }
+
+  @if $index > $length {
+    @return append($list, $value, list-separator($list));
+  }
+
+  $result: ();
+
+  @for $i from 1 through $length {
+    @if $i == $index {
+      @if is-true($value) {
+        $result: append($result, $value, list-separator($list));
+      }
+    }
+
+    $result: append($result, nth($list, $i), list-separator($list));
+  }
+
+  @return $result;
+}

data/stylesheets/SassyLists/_intersection.scss

@@ -1,27 +1,29 @@
-// Returns a list of shared value from $list and $lists minus duplicates
-// -------------------------------------------------------------------------------
-// @documentation http://sassylists.com/documentation/#intersection
-// -------------------------------------------------------------------------------
-// @param $list [List] : first list
-// @param $lists [ArgList] : other lists
-// -------------------------------------------------------------------------------
-// @return [List]
-
-@function intersection($list, $lists...) {
-  $result: $list;
-
-  @each $list in $lists {
-    $temp: ();
-
-    @each $item in $result {
-      @if not not index($list, $item) {
-        $temp: append($temp, $item, list-separator($list));
-      }
-    }
-
-    $result: $temp;
-  }
-
-  $result: remove-duplicates($result);
-  @return if(length($result) == 1, nth($result, 1), $result);
+// Returns a list of shared value from $list and $lists minus duplicates
+//
+// @ignore Documentation: http://sassylists.com/documentation/#intersection
+//
+// @requires remove-duplicates
+//
+// @param {List}    $list  - first list
+// @param {ArgList} $lists - other lists
+//
+// @return {List}
+
+@function intersection($list, $lists...) {
+  $result: $list;
+
+  @each $list in $lists {
+    $temp: ();
+
+    @each $item in $result {
+      @if not not index($list, $item) {
+        $temp: append($temp, $item, list-separator($list));
+      }
+    }
+
+    $result: $temp;
+  }
+
+  $result: remove-duplicates($result);
+  @return if(length($result) == 1, nth($result, 1), $result);
 }

data/stylesheets/SassyLists/_is-symmetrical.scss

@@ -1,20 +1,19 @@
-// Checks whether $list is symmetrical (one-level deep)
-// -------------------------------------------------------------------------------
-// @documentation http://sassylists.com/documentation/#is-symmetrical
-// -------------------------------------------------------------------------------
-// @alias `unfold()`
-// -------------------------------------------------------------------------------
-// @dependence `reverse()`
-// -------------------------------------------------------------------------------
-// @param $list [List] : list
-// -------------------------------------------------------------------------------
-// @return [Boolean]
-
-@function is-symmetrical($list) {
-  @return $list == reverse($list);
-}
-
-// Alias
-@function is-mirror($list) {
-  @return is-symmetrical($list);
+// Checks whether $list is symmetrical (one-level deep)
+//
+// @ignore Documentation: http://sassylists.com/documentation/#is-symmetrical
+//
+// @requires reverse
+//
+// @param {List} $list - list to check
+//
+// @return {Bool}
+
+@function is-symmetrical($list) {
+  @return $list == reverse($list);
+}
+
+// @alias is-symmetrical
+
+@function is-mirror($list) {
+  @return is-symmetrical($list);
 }

data/stylesheets/SassyLists/_last-index.scss

@@ -1,21 +1,20 @@
-// Returns last index of $value in $list
-// -------------------------------------------------------------------------------
-// @documentation http://sassylists.com/documentation/#last-index
-// -------------------------------------------------------------------------------
-// @param $list [List] : list
-// @param $value [Literal] : value to be searched for
-// -------------------------------------------------------------------------------
-// @return [Number] | null
-
-@function last-index($list, $value) {
-  $length: length($list);
-
-  @for $i from $length * -1 through -1 {
-    $i: abs($i);
-    @if nth($list, $i) == $value {
-      @return $i;
-    }
-  }
-
-  @return null;
-}
+// Returns last index of $value in $list
+//
+// @ignore Documentation: http://sassylists.com/documentation/#last-index
+//
+// @param {List}    $list  - list to search
+// @param {*}       $value - value to be searched for
+//
+// @return {Number | Null}
+
+@function last-index($list, $value) {
+  $length: length($list);
+
+  @for $i from $length through 1 {
+    @if nth($list, $i) == $value {
+      @return $i;
+    }
+  }
+
+  @return null;
+}

data/stylesheets/SassyLists/_last.scss

@@ -1,25 +1,18 @@
-// Returns last element of $list
-// -------------------------------------------------------------------------------
-// @documentation http://sassylists.com/documentation/#last
-// -------------------------------------------------------------------------------
-// @alias `tail()`
-// -------------------------------------------------------------------------------
-// @param $list [List] : list
-// -------------------------------------------------------------------------------
-// @raise [Error] if list is empty
-// -------------------------------------------------------------------------------
-// @return [Literal] | false
-
-@function last($list) {
-  @if length($list) == 0 {
-    @warn "Cannot find last item of empty list.";
-    @return false;
-  }
-
-  @return nth($list, length($list));
-}
-
-// Alias
-@function tail($list) {
-  @return last($list);
+// Returns last element of $list
+//
+// @ignore Documentation: http://sassylists.com/documentation/#last
+//
+// @param {List} $list - list to retrieve last value from
+//
+// @throws Cannot find last item of empty list.
+//
+// @return {*}
+
+@function last($list) {
+  @if length($list) == 0 {
+    @warn "Cannot find last item of empty list.";
+    @return false;
+  }
+
+  @return nth($list, -1);
 }

data/stylesheets/SassyLists/_loop.scss

@@ -1,37 +1,36 @@
-// Shift indexes from $list of $value
-// -------------------------------------------------------------------------------
-// @documentation http://sassylists.com/documentation/#loop
-// -------------------------------------------------------------------------------
-// @alias `shift-indexes()`
-// -------------------------------------------------------------------------------
-// @param $list [List] : list
-// @param $value [Number] : number of position between old and new indexes
-// -------------------------------------------------------------------------------
-// @raise [Error] if $value isn't an integer
-// -------------------------------------------------------------------------------
-// @return [List] | false
-
-@function loop($list, $value: 1) {
-  @if type-of($value) != "number" {
-    @warn "#{$value} is not a number for `loop`.";
-    @return false;
-  }
-
-  @if length($list) < 2 {
-    @return $list;
-  }
-
-  $result: ();
-  $length: length($list);
-
-  @for $i from 0 to $length {
-    $result: append($result, nth($list, ($i - $value) % $length + 1), list-separator($list));
-  }
-
-  @return $result;
-}
-
-// Alias
-@function shift-indexes($list, $value: 1) {
-  @return loop($list, $value);
+// Shift indexes from $list of $value
+//
+// @ignore Documentation: http://sassylists.com/documentation/#loop
+//
+// @param {List}   $list      - list to update
+// @param {Number} $value (1) - number of position between old and new indexes
+//
+// @throws $value is not a number for `loop`.
+//
+// @return {List | Bool}
+
+@function loop($list, $value: 1) {
+  @if type-of($value) != "number" {
+    @warn "#{$value} is not a number for `loop`.";
+    @return false;
+  }
+
+  @if length($list) < 2 {
+    @return $list;
+  }
+
+  $result: ();
+  $length: length($list);
+
+  @for $i from 0 to $length {
+    $result: append($result, nth($list, ($i - $value) % $length + 1), list-separator($list));
+  }
+
+  @return $result;
+}
+
+// @alias shift-indexes
+
+@function shift-indexes($list, $value: 1) {
+  @return loop($list, $value);
 }

data/stylesheets/SassyLists/_prepend.scss

@@ -1,20 +1,20 @@
-// Adds $value as first index of $list
-// -------------------------------------------------------------------------------
-// @documentation http://sassylists.com/documentation/#prepend
-// -------------------------------------------------------------------------------
-// @dependence `is-true()`
-// -------------------------------------------------------------------------------
-// @param $list [List] : list
-// @param $value [Literal] : value to prepend to the list
-// -------------------------------------------------------------------------------
-// @return [List]
-
-@function prepend($list, $value) {
-  @if is-true($value) {
-    @return join($value, $list, list-separator($list));
-  }
-
-  @else {
-    @return $list;
-  }
-}
+// Adds $value as first index of $list
+//
+// @ignore Documentation: http://sassylists.com/documentation/#prepend
+//
+// @requires is-true
+//
+// @param {List}    $list  - list to preprend value to
+// @param {*}       $value - value to prepend to the list
+//
+// @return {List}
+
+@function prepend($list, $value) {
+  @if is-true($value) {
+    @return join($value, $list, list-separator($list));
+  }
+
+  @else {
+    @return $list;
+  }
+}

data/stylesheets/SassyLists/_purge.scss

@@ -1,28 +1,27 @@
-// Removes all false and null values from $list
-// -------------------------------------------------------------------------------
-// @documentation http://sassylists.com/documentation.html#purge
-// -------------------------------------------------------------------------------
-// @alias `clean()`
-// -------------------------------------------------------------------------------
-// @dependence `is-true()`
-// -------------------------------------------------------------------------------
-// @param $list [List] : list
-// -------------------------------------------------------------------------------
-// @return [List]
-
-@function purge($list) {
-  $result: ();
-
-  @each $item in $list {
-    @if is-true($item) {
-      $result: append($result, $item, list-separator($list));
-    }
-  }
-
-  @return $result;
-}
-
-// Alias
-@function clean($list) {
-  @return purge($list);
-}
+// Removes all false and null values from $list
+//
+// @ignore Documentation: http://sassylists.com/documentation.html#purge
+//
+// @requires is-true
+//
+// @param {List} $list - list to purge
+//
+// @return {List}
+
+@function purge($list) {
+  $result: ();
+
+  @each $item in $list {
+    @if is-true($item) {
+      $result: append($result, $item, list-separator($list));
+    }
+  }
+
+  @return $result;
+}
+
+// @alias purge
+
+@function clean($list) {
+  @return purge($list);
+}

data/stylesheets/SassyLists/_random-value.scss

@@ -1,32 +1,30 @@
-// Returns a random value of $list
-// -------------------------------------------------------------------------------
-// @documentation http://sassylists.com/documentation.html#random-value
-// -------------------------------------------------------------------------------
-// @alias `roll()`
-// @alias `luck()`
-// -------------------------------------------------------------------------------
-// @dependence `random()` (Ruby)
-// -------------------------------------------------------------------------------
-// @param $list [List] : List
-// -------------------------------------------------------------------------------
-// @raise [Error] if $list is empty
-// -------------------------------------------------------------------------------
-// @return [Literal] | false
-
-@function random-value($list) {
-  @if length($list) == 0 {
-    @warn "Cannot find a random value in an empty list.";
-    @return false;
-  }
-
-  @return nth($list, random(length($list)) + 1);
-}
-
-// Aliases
-@function roll($list) {
-  @return random-value($list);
-}
-
-@function luck($list) {
-  @return random-value($list);
+// Returns a random value of $list
+//
+// @ignore Documentation: http://sassylists.com/documentation.html#random-value
+//
+// @param {List} $list - list to random value from
+//
+// @throws Cannot find a random value in an empty list.
+//
+// @return {*}
+
+@function random-value($list) {
+  @if length($list) == 0 {
+    @warn "Cannot find a random value in an empty list.";
+    @return false;
+  }
+
+  @return nth($list, random(length($list)) + 1);
+}
+
+// @alias random-value
+
+@function roll($list) {
+  @return random-value($list);
+}
+
+// @alias random-value
+
+@function luck($list) {
+  @return random-value($list);
 }

data/stylesheets/SassyLists/_remove-duplicates.scss

@@ -1,27 +1,25 @@
-// Removes duplicate values from $list
-// -------------------------------------------------------------------------------
-// @documentation http://sassylists.com/documentation/#remove-duplicates
-// -------------------------------------------------------------------------------
-// @alias `unique()`
-// -------------------------------------------------------------------------------
-// @param $list [List] : list
-// @param $recursive [Boolean] : enable / disable recursivity
-// -------------------------------------------------------------------------------
-// @return [List]
-
-@function remove-duplicates($list) {
-  $result: ();
-
-  @each $item in $list {
-    @if not index($result, $item) {
-      $result: append($result, $item, list-separator($list));
-    }
-  }
-
-  @return $result;
-}
-
-// Alias
-@function unique($list, $recursive: false) {
-  @return remove-duplicates($list, $recursive);
+// Removes duplicate values from $list
+//
+// @ignore Documentation: http://sassylists.com/documentation/#remove-duplicates
+//
+// @param {List} $list - list to remove duplicates from
+//
+// @return {List}
+
+@function remove-duplicates($list) {
+  $result: ();
+
+  @each $item in $list {
+    @if not index($result, $item) {
+      $result: append($result, $item, list-separator($list));
+    }
+  }
+
+  @return $result;
+}
+
+// @alias remove-duplicates
+
+@function unique($list, $recursive: false) {
+  @return remove-duplicates($list, $recursive);
 }