Bumped 2.2.3

CHANGELOG.md

@@ -1,5 +1,6 @@
 # Changelog
 
+* `2.2.3`: adding examples to documentation
 * `2.2.2`: fixing a bug with aliases for `sl-to-list()` and moved all comments to C-like
 * `2.2.1`: improving `sl-to-list()`'s performance
 * `2.2.0`: 

bower.json

@@ -1,6 +1,6 @@
 {
   "name": "SassyLists",
-  "version": "2.2.2",
+  "version": "2.2.3",
   "homepage": "https://github.com/Team-Sass/SassyLists",
   "authors": [
     "Hugo Giraudel"

lib/SassyLists.rb

@@ -15,7 +15,7 @@
 #  Version is a number. If a version contains alphas, it will be created as a prerelease version
 #  Date is in the form of YYYY-MM-DD
 module SassyLists
-  VERSION = "2.2.2"
+  VERSION = "2.2.3"
   DATE = "2014-07-05"
 end
 

package.json

@@ -1,6 +1,6 @@
 {
   "name": "SassyLists",
-  "version": "2.2.2",
+  "version": "2.2.3",
   "description": "A Sass API for lists.",
   "scripts": {
     "test": "grunt test"

stylesheets/SassyLists/_chunk.scss

@@ -10,6 +10,10 @@
  *
  * @requires sl-to-list
  *
+ * @example
+ * sl-chunk(a b c d e, 2)
+ * // a b, c d, e
+ *
  * @return {List | Null}
  */
 

stylesheets/SassyLists/_comma-list.scss

@@ -3,6 +3,10 @@
  * 
  * @ignore Documentation: http://sassylists.com/documentation.html#sl-comma-list
  *
+ * @example
+ * sl-comma-list()
+ * // ()
+ *
  * @return {List}
  */
 

stylesheets/SassyLists/_contain.scss

@@ -6,6 +6,14 @@
  * @param {List}    $list  - list to check
  * @param {*}       $value - value to look for
  *
+ * @example
+ * sl-contain(a b c, a)
+ * // true
+ *
+ * @example
+ * sl-contain(a b c, z)
+ * // false
+ *
  * @return {Bool}
  */
 

stylesheets/SassyLists/_count-values.scss

@@ -5,6 +5,10 @@
  *
  * @param {List} $list - list to count values from
  *
+ * @example
+ * sl-count-values(a b c a)
+ * // (a: 2, b: 1, c: 1) 
+ *
  * @return {Map} Values mapped to their count
  */
 

stylesheets/SassyLists/_debug.scss

@@ -11,6 +11,10 @@
  * @requires sl-is-single
  * @requires sl-has-multiple-values
  * 
+ * @example
+ * sl-debug(a b c)
+ * // '("a", "b", "c")'
+ *
  * @return {String}
  */
 

stylesheets/SassyLists/_every.scss

@@ -7,6 +7,14 @@
  * @param {String}  $function - function to run against every item from list
  * @param {ArgList} $args     - extra arguments to pass to the function
  *
+ * @example
+ * sl-every(1 2 3, unitless)
+ * // true
+ *
+ * @example
+ * sl-every(1 2 3px, unitless)
+ * // false
+ *
  * @return {Bool}
  */
 

stylesheets/SassyLists/_explode.scss

@@ -10,6 +10,14 @@
  * @throws $string is not a string for `sl-explode`.
  * @throws $delimiter is not a string for `sl-explode`.
  *
+ * @example
+ * sl-explode(abc)
+ * // a b c
+ *
+ * @example
+ * sl-explode(abc, b)
+ * // a c
+ * 
  * @return {List | Null}
  */
 

stylesheets/SassyLists/_first.scss

@@ -7,6 +7,18 @@
  * @throws Cannot find first item of empty list.
  *
  * @requires sl-is-empty
+ *
+ * @example
+ * sl-first(a b c)
+ * // a
+ *
+ * @example
+ * sl-first(a)
+ * // a
+ *
+ * @example
+ * sl-first(())
+ * // null
  * 
  * @return {*}
  */

stylesheets/SassyLists/_flatten.scss

@@ -6,7 +6,11 @@
  * @param {List} $list - list to flatten
  * 
  * @requires sl-has-multiple-values
- * 
+ *
+ * @example
+ * sl-flatten(a b c, d e f, g h i)
+ * // a b c d e f g h i
+ *
  * @return {List}
  */
 

stylesheets/SassyLists/_has-multiple-values.scss

@@ -5,6 +5,14 @@
  *
  * @param {List} $list - list to run test against
  *
+ * @example 
+ * sl-has-multiple-values(a)
+ * // false
+ *
+ * @example 
+ * sl-has-multiple-values(a b)
+ * // true
+ * 
  * @return {Bool}
  */
 

stylesheets/SassyLists/_has-values.scss

@@ -4,6 +4,14 @@
  *
  * @param {List} $list - list to run test against
  *
+ * @example 
+ * sl-has-values(a)
+ * // true
+ *
+ * @example 
+ * sl-has-values(())
+ * // false
+ * 
  * @return {Bool}
  */
 

stylesheets/SassyLists/_insert-nth.scss

@@ -11,6 +11,18 @@
  * @throws List index $index is not a number for `sl-insert-nth`.
  * @throws List index $index must be a non-zero integer for `sl-insert-nth`.
  *
+ * @example
+ * sl-insert-nth(a b c, 2, z)
+ * // a z b c
+ *
+ * @example
+ * sl-insert-nth(a b c, 42, z)
+ * // a b c z
+ *
+ * @example 
+ * sl-insert-nth(a b c, -42, z)
+ * // null
+ * 
  * @return {List | Null}
  */
 

stylesheets/SassyLists/_intersection.scss

@@ -9,6 +9,10 @@
  * @param {List}    $list  - first list
  * @param {ArgList} $lists - other lists
  *
+ * @example
+ * sl-intersection(a b c, b e d, a c b)
+ * // b
+ * 
  * @return {List}
  */
 

stylesheets/SassyLists/_is-empty.scss

@@ -5,6 +5,14 @@
  *
  * @param {List} $list - list to run test against
  *
+ * @example
+ * sl-is-empty(())
+ * // true
+ *
+ * @example
+ * sl-is-empty(a)
+ * // false
+ *
  * @return {Bool}
  */
 

stylesheets/SassyLists/_is-single.scss

@@ -5,6 +5,18 @@
  *
  * @param {List} $list - list to run test against
  *
+ * @example
+ * sl-is-single(())
+ * // false
+ *
+ * @example
+ * sl-is-single(a)
+ * // true
+ *
+ * @example
+ * sl-is-single(a b)
+ * // false
+ *
  * @return {Bool}
  */
 

stylesheets/SassyLists/_is-symmetrical.scss

@@ -7,6 +7,15 @@
  *
  * @param {List} $list - list to check
  *
+ * @example
+ * sl-is-symmetrical(a b c)
+ * // false
+ *
+ * 
+ * @example
+ * sl-is-symmetrical(a b a)
+ * // true
+ *
  * @return {Bool}
  */
 

stylesheets/SassyLists/_last-index.scss

@@ -6,6 +6,14 @@
  * @param {List} $list  - list to search
  * @param {*}    $value - value to be searched for
  *
+ * @example
+ * sl-last-index(a b a, a)
+ * // 3
+ *
+ * @example
+ * sl-last-index(a b a, z)
+ * // null
+ *
  * @return {Number | Null}
  */
 

stylesheets/SassyLists/_last.scss

@@ -8,6 +8,18 @@
  * @throws Cannot find last item of empty list.
  *
  * @requires sl-is-empty
+ *
+ * @example
+ * sl-last(a b c)
+ * // c
+ * 
+ * @example
+ * sl-last(a)
+ * // a
+ *
+ * @example
+ * sl-last(())
+ * // null
  * 
  * @return {*}
  */

stylesheets/SassyLists/_loop.scss

@@ -11,7 +11,15 @@
  * @throws $value is not a number for `loop`.
  *
  * @requires sl-has-multiple-values
+ *
+ * @example
+ * sl-loop(a b c)
+ * // c a b
  * 
+ * @example
+ * sl-loop(a b c, 2)
+ * // b c a
+ *
  * @return {List | Null}
  */
 

stylesheets/SassyLists/_prepend.scss

@@ -9,6 +9,10 @@
  * @param {List} $list  - list to preprend value to
  * @param {*}    $value - value to prepend to the list
  *
+ * @example
+ * sl-prepend(a b c, z)
+ * // z a b c
+ * 
  * @return {List}
  */
 

stylesheets/SassyLists/_purge.scss

@@ -7,6 +7,10 @@
  *
  * @param {List} $list - list to purge
  *
+ * @example
+ * sl-purge(null a false b)
+ * // a b
+ *
  * @return {List}
  */
 

stylesheets/SassyLists/_random-value.scss

@@ -8,6 +8,10 @@
  * @throws Cannot find a random value in an empty list.
  *
  * @requires sl-is-empty
+ *
+ * @example
+ * sl-random-value(a b c)
+ * // a
  * 
  * @return {*}
  */

stylesheets/SassyLists/_range.scss

@@ -9,6 +9,18 @@
  * @throws `$n` is not unitless for `sl-range`.
  * @throws `$n` is not greater than 0 for `sl-range`.
  *
+ * @example
+ * sl-range(5)
+ * // 1 2 3 4 5
+ *
+ * @example
+ * sl-range(1)
+ * // 1
+ *
+ * @example
+ * sl-range(-42)
+ * // null
+ *
  * @return {List | Number | Null}
  */
 

stylesheets/SassyLists/_remove-duplicates.scss

@@ -7,6 +7,10 @@
  *
  * @requires sl-to-list
  *
+ * @example
+ * sl-remove-duplicates(a b a b)
+ * // a b
+ *
  * @return {List}
  */
 

stylesheets/SassyLists/_remove-nth.scss

@@ -8,6 +8,14 @@
  * @param {List}   $list  - list to remove value from
  * @param {Number} $index - index to remove
  *
+ * @example
+ * sl-remove-nth(a b c, 2)
+ * // a c
+ *
+ * @example
+ * sl-remove-nth(a b c, 42)
+ * // null
+ *
  * @return {List | Null}
  */