flint-gs 2.0.0.rc.1 → 2.0.0.rc.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 4395d92039fd59ac3d1a014a9be9da91de0b572a
-  data.tar.gz: 7b9b29f7cdfbfad0c3222517171d1b559578e67f
+  metadata.gz: 02a09b99c00123a921944c891d048c34e7e0b4a1
+  data.tar.gz: 97e2da293b83ff752d6d20f42bfd2e890893d8e4
 SHA512:
-  metadata.gz: 215c6c6d3c6b81878958aa133adb5eb369ac1645b5d76ca8fc64e5cc807549cd976cb2dcff9570dda67eb2eeb2fa3f933aa2dc5125f2b0528429ac626edbf668
-  data.tar.gz: 125c5148f136d0842f6ef5496539544c549a1d313b9d8c44ca0f23d603646861018f8ea9cb487d9f9e1f07524bea416ad4bcfe21dd587e37a33eb0e8ca3f0f2c
+  metadata.gz: c8a1542d622faccaa31b85cc8a9830a0e6505be79591f2bc8a523a7cea05322090564dabbc6ba7f1176c32d2353149b491d858b2d673faaa19119cfa96155251
+  data.tar.gz: f9d5b242956671f27b5486c0966d590206042bad5331a806a12360282fa0d673351ccd7936591e04bde12f5b0a0b7a0f356058f8d982e8cd38dbedf10b2d684a

data/README.md

@@ -36,17 +36,19 @@ Enjoy.
 
 ## Installation
 
-1. Install via Ruby `gem install flint-gs`, or Bower `bower install flint --save-dev`
+1. Install via Ruby `gem install flint-gs --pre`, or Bower `bower install flint --save-dev`
 2. If you're using Compass, add `require "flint"` to your `config.rb`
 3. Import it into your stylesheet with `@import "flint"`
 
-If you're not using Compass, you can require the custom Ruby functions and compile via:
+If you're not using Compass, you can require Flint and compile via:
 ```
 scss --require ./lib/flint.rb example.scss > example.css
 ```
 
 ## Documentation
 
+_Fully updated documentation on Flint `2.0` is coming soon. It will be housed on the [website](http:flint.gs) when the time comes. Keep an eye out!_
+
 ### Config
 
 Getting up and running with Flint is simple: you can either configure your own grid, or use the default grid setup that ships with Flint. Being able to quickly configure a grid was at the forefront of my goals when developing Flint; and so it offers an immense configuration map, which is essentially a Sass map of all your project’s grid settings and breakpoints. You don’t have to mess with endless variables just to get your project up and running. Instead, you just create a single variable called `$flint`:
@@ -59,25 +61,24 @@ To begin, you can either use the default `config` (below) which comes baked in,
 
 ```scss
 /**
-* Configuration map
-*
-* @prop {Map}    breakpoints                  - map of breakpoints, follow DSC order
-* @prop {Map}    breakpoints.alias            - named map of breakpoint settings
-* @prop {Number} breakpoints.alias.columns    - column count for breakpoint
-* @prop {Number} breakpoints.alias.breakpoint - breakpoint value for breakpoint
-* @prop {Map}    settings                     - map of settings for grid
-* @prop {String} settings.default             - alias of breakpoint to be grid default
-* @prop {String} settings.grid                - type of grid
-* @prop {Number} settings.gutter              - value for gutter
-* @prop {String} settings.float-direction     - direction of float
-* @prop {Bool}   settings.max-width           - maximum width value
-* @prop {Bool}   settings.max-width           - maximum width value
-* @prop {Bool}   settings.center-container    - center containers
-* @prop {Bool}   settings.border-box-sizing   - use `box-sizing: border-box`
-* @prop {Bool}   settings.instance-maps       - use instance maps for added features
-* @prop {Bool}   settings.support-syntax      - support syntax within instance functions
-* @prop {Bool}   settings.debug-mode          - enable debug mode
-*/
+ * Configuration map
+ *
+ * @prop {Map}    breakpoints                  - map of breakpoints, follow DSC order
+ * @prop {Map}    breakpoints.alias            - named map of breakpoint settings
+ * @prop {Number} breakpoints.alias.columns    - column count for breakpoint
+ * @prop {Number} breakpoints.alias.breakpoint - breakpoint value for breakpoint
+ * @prop {Map}    settings                     - map of settings for grid
+ * @prop {String} settings.default             - alias of breakpoint to be grid default
+ * @prop {String} settings.grid                - type of grid
+ * @prop {Number} settings.gutter              - value for gutter
+ * @prop {String} settings.float-direction     - direction of float
+ * @prop {Bool}   settings.max-width           - maximum width value
+ * @prop {Bool}   settings.center-container    - center containers
+ * @prop {Bool}   settings.border-box-sizing   - use `box-sizing: border-box`
+ * @prop {Bool}   settings.instance-maps       - use instance maps for added features
+ * @prop {Bool}   settings.support-syntax      - support syntax within instance functions
+ * @prop {Bool}   settings.debug-mode          - enable debug mode
+ */
 $flint: (
 	"breakpoints": (
 		"desktop": (

data/lib/flint.rb

@@ -10,33 +10,30 @@ else
 end
 
 module Flint
-    VERSION = "2.0.0.rc.1"
-    DATE = "2014-09-12"
+    VERSION = "2.0.0.rc.2"
+    DATE = "2014-09-16"
 end
 
-# Custom functions
 module Sass::Script::Functions
 
+    ###
     # Use ruby functions
-    # ----
+    #
+    # @return {Bool}
+    ###
     def flint_use_ruby()
         Sass::Script::Bool.new(true)
     end
 
-    # # Returns stringified selector
-    # # ----
-    # # @return [string]
-    # def selector_string()
-    #     Sass::Script::String.new(environment.selector.to_s)
-    # end
-
+    ###
     # Turns string into a flat list
-    # ----
-    # @param string [string] : string
-    # @param separator [string] : item to find which separates substrings
-    # @param ignore [string] : removes remaining string beyond item
-    # ----
-    # @return [list] | error
+    #
+    # @param {String} string    - string
+    # @param {String} separator - item to find which separates substrings
+    # @param {String} ignore    - removes remaining string beyond item
+    #
+    # @return {List}
+    ###
     def string_to_list(string, separator, ignore)
         # Remove rest of string after ignore
         ignore = string.value[/[^#{ignore}]+/]
@@ -50,19 +47,16 @@ module Sass::Script::Functions
         end
     end
 
+    ###
     # Replace substring
-    # ----
-    # @param string [string] : string that contains substring
-    # @param find [string] : substring to replace
-    # @param replace [string] : new string to replace sub with
-    # ----
-    # @return [string]
+    #
+    # @param {String} string  - string that contains substring
+    # @param {String} find    - substring to replace
+    # @param {String} replace - new string to replace sub with
+    #
+    # @return {String}
+    ###
     def replace_substring(string, find, replace)
-        # Assert types
-        assert_type string, :String
-        assert_type find, :String
-        assert_type replace, :String
-        # Return new string
         Sass::Script::String.new(string.value.gsub(find.value, replace.value))
     end
 

data/stylesheets/flint/config/_config.scss

@@ -11,7 +11,6 @@
  * @prop {Number} settings.gutter              - value for gutter
  * @prop {String} settings.float-direction     - direction of float
  * @prop {Bool}   settings.max-width           - maximum width value
- * @prop {Bool}   settings.max-width           - maximum width value
  * @prop {Bool}   settings.center-container    - center containers
  * @prop {Bool}   settings.border-box-sizing   - use `box-sizing: border-box`
  * @prop {Bool}   settings.instance-maps       - use instance maps for added features

data/stylesheets/flint/functions/helpers/_helpers.scss

@@ -1,6 +1,8 @@
 /**
  * Returns truthiness of a value
  *
+ * @access private
+ *
  * @param {*} $value
  *
  * @return {Bool}
@@ -12,6 +14,8 @@
 /**
  * Checks if item is map
  *
+ * @access private
+ *
  * @param {Map} $n
  *
  * @return {Bool}
@@ -23,6 +27,8 @@
 /**
  * Checks if item is list
  *
+ * @access private
+ *
  * @param {List} $n
  *
  * @return {Bool}
@@ -34,6 +40,8 @@
 /**
  * Checks if item is number
  *
+ * @access private
+ *
  * @param {Number} $n
  *
  * @return {Bool}
@@ -45,6 +53,8 @@
 /**
  * Checks if item is string
  *
+ * @access private
+ *
  * @param {String} $n
  *
  * @return {Bool}
@@ -56,6 +66,8 @@
 /**
  * Checks if item is not string
  *
+ * @access private
+ *
  * @param {String} $n
  *
  * @return {Bool}
@@ -67,6 +79,8 @@
 /**
  * Get gutter value from config map
  *
+ * @access private
+ *
  * @return {Number}
  */
 @function flint-get-gutter() {
@@ -76,6 +90,8 @@
 /**
  * Gets list of each breakpoint's key
  *
+ * @access private
+ *
  * @return {List}
  */
 @function flint-get-all-keys() {
@@ -85,6 +101,8 @@
 /**
  * Gets list of all breakpoints
  *
+ * @access private
+ *
  * @return {List}
  */
 @function flint-get-all-breakpoints() {
@@ -101,6 +119,8 @@
 /**
  * Checks if passed $key is the highest breakpoint
  *
+ * @access private
+ *
  * @param {String} $key - alias of breakpoint
  *
  * @return {Bool}
@@ -112,6 +132,8 @@
 /**
  * Checks if passed $key is the lowest breakpoint
  *
+ * @access private
+ *
  * @param {String} $key - alias of breakpoint
  *
  * @return {Bool}
@@ -123,6 +145,8 @@
 /**
  * Checks if $key is grid default
  *
+ * @access private
+ *
  * @param {String} $key - alias of breakpoint
  *
  * @return {Bool}
@@ -134,6 +158,8 @@
 /**
  * Gets all breakpoint column values
  *
+ * @access private
+ *
  * @return {List}
  */
 @function flint-get-all-columns() {
@@ -150,6 +176,8 @@
 /**
  * Returns the unit used in config
  *
+ * @access private
+ *
  * @return {*}
  */
 @function flint-get-config-unit() {
@@ -159,6 +187,8 @@
 /**
  * Convert pixel value to em
  *
+ * @access private
+ *
  * @param {Number} $target  - pixel value
  * @param {Number} $context - context to divide by
  *
@@ -172,6 +202,8 @@
  * Use Ruby functions in place of Sass functions where possible
  *   to speed up performance, especially with string functions
  *
+ * @access private
+ *
  * @return {Bool}
  */
 @function flint-use-ruby-functions() {

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

@@ -1,6 +1,8 @@
 /**
  * Calculate breakpoint query
  *
+ * @access private
+ *
  * @param {String} $type - type of query to get
  * @param {String} $key  - key of breakpoint
  * @param {Number} $i    - index of current breakpoint

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

@@ -1,6 +1,8 @@
 /**
 * Calculate width
 *
+* @access private
+*
 * @param {String}          $key            - key of breakpoint
 * @param {Number}          $span           - span value of element
 * @param {Number | String} $context (null) - context value of element

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

@@ -1,8 +1,10 @@
 /**
  * Check if key exists in map
  *
+ * @access private
+ *
  * @param {Map}    $map   - map to search
- * @param {Strong} $value - key to search for
+ * @param {String} $value - key to search for
  *
  * @return {Bool}
  */

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

@@ -1,6 +1,8 @@
 /**
  * Convert fixed to fluid width
  *
+ * @access private
+ *
  * @param {Number} $target
  * @param {Number} $context
  *

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

@@ -1,6 +1,8 @@
 /**
  * Gets the index of the passed key
  *
+ * @access private
+ *
  * @param {String} $key - breakpoint key
  *
  * @return {Number}

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

@@ -1,6 +1,8 @@
 /**
  * Get single value from key in instance map based on $selector::$key
  *
+ * @access private
+ *
  * @param {String}  $key    - breakpoint key to pass to instance method
  * @param {ArgList} $values - list of keys to fetch value from
  *

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

@@ -1,6 +1,8 @@
 /**
  * Get single value from configuration map
  *
+ * @access private
+ *
  * @param {ArgList} $keys - list of keys to fetch value from
  *
  * @return {*}

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

@@ -1,6 +1,8 @@
 /**
  * Checks if instance flint-exists in selector familiy tree, falls back from current selector
  *
+ * @access private
+ *
  * @param {String} $key    - breakpoint key to search for matching instance
  * @param {String} $syntax - searches for instance using passed syntax parser
  *

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

@@ -1,6 +1,8 @@
 /**
  * Keeps count of all instances with arguments, stores in global var
  *
+ * @access private
+ *
  * @param {String} $key                 - computed breakpoint of instance
  * @param {Number} $span                - computed span of instance
  * @param {Number} $context             - computed context of instance

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

@@ -1,6 +1,8 @@
 /**
  * Get last item in list
  *
+ * @access private
+ *
  * @param {List} $list
  *
  * @return {List}

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

@@ -1,6 +1,8 @@
 /**
  * Joins all elements of list with passed glue
  *
+ * @access private
+ *
  * @link http://sassylists.com/documentation/#to-string
  *
  * @param {List}   $list

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

@@ -1,6 +1,8 @@
 /**
  * Fetch value from map
  *
+ * @access private
+ *
  * @param {Map}     $map  - map to fetch value from
  * @param {ArgList} $keys - list of keys to traverse
  *

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

@@ -1,6 +1,8 @@
 /**
  * Returns next indexed key based on passed index
  *
+ * @access private
+ *
  * @param {Number} $index - index of breakpoint
  *
  * @return {String | False}

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

@@ -1,6 +1,8 @@
 /**
  * Removes all false and null values from $list
  *
+ * @access private
+ *
  * @link http://sassylists.com/documentation.html#purge
  *
  * @param {List} $list

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

@@ -1,6 +1,8 @@
 /**
  * Remove value from list
  *
+ * @access private
+ *
  * @link http://sassylists.com/documentation/#remove
  *
  * @param {List} $list

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

@@ -1,6 +1,8 @@
 /**
  * Replace substring
  *
+ * @access private
+ *
  * @param {String} $string              - string that contains substring
  * @param {String} $substring           - substring to replace
  * @param {String} $new-substring (" ") - new string to replace sub with

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

@@ -1,6 +1,8 @@
 /**
  * Replaces old by new in $list
  *
+ * @access private
+ *
  * @link http://sassylists.com/documentation.html#replace
  *
  * @param {List} $list

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

@@ -1,6 +1,8 @@
 /**
  * Steal breakpoint key by index
  *
+ * @access private
+ *
  * @param {Number} $index - index of key
  *
  * @return {String | False}

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

@@ -1,6 +1,8 @@
 /**
  * Steal breakpoint value by index
  *
+ * @access private
+ *
  * @param {Number} $index - index of key
  * @param {String} $value - value to get from breakpoint
  *

data/stylesheets/flint/functions/lib/_string-to-list.scss

@@ -1,6 +1,8 @@
 /**
  * Turns string into a flat list
  *
+ * @access private
+ *
  * @param {String} $string
  * @param {String} $find   (" ") - item to find which separates substrings
  * @param {String} $ignore (",") - removes remaining string beyond item

data/stylesheets/flint/functions/lib/_support-syntax-bem.scss

@@ -1,6 +1,8 @@
 /**
  * Parser to support BEM syntax
  *
+ * @access private
+ *
  * @param {List} $selectors - string of selectors to parse
  *
  * @return {List} - parsed list of selectors according to syntax

data/stylesheets/flint/functions/lib/_support-syntax.scss

@@ -1,6 +1,8 @@
 /**
  * Support syntax
  *
+ * @access private
+ *
  * @param {String} $syntax    - alias of syntax to support
  * @param {List}   $selectors - string of selectors to parse
  *

data/stylesheets/flint/functions/lib/_types-in-list.scss

@@ -1,6 +1,8 @@
 /**
  * Checks type of each item in list
  *
+ * @access private
+ *
  * @param {List} $list                          - list of items
  * @param {String | List} $assert-types  (null) - single or list of types to assert
  * @param {Number}        $assert-length (null) - assert length of list

data/stylesheets/flint/functions/lib/_use-syntax.scss

@@ -1,6 +1,8 @@
 /**
  * Use global syntax
  *
+ * @access private
+ *
  * @param {List} $selectors - string of selectors to parse
  *
  * @return {List} - parsed list of selectors

data/stylesheets/flint/globals/_globals.scss

@@ -1,52 +1,100 @@
 /*
  * Use development mode to silence fatal errors
+ *
+ * @access private
+ *
+ * @type {Bool}
  */
 $flint__development-mode: false !global;
 
 /*
- * Set global variable to check if foundation has been applied globally
+ * Set global variable to check if foundation has been set
+ *
+ * @access private
+ *
+ * @type {String}
  */
 $flint__foundation: "non-existent" !global;
 
 /*
  * Gather all keys, breakpoints and column counts
+ *
+ * @access private
+ *
+ * @type {List}
  */
-$flint__all__keys: flint-get-all-keys() !global;
-$flint__all__breakpoints: flint-get-all-breakpoints() !global;
-$flint__all__columns: flint-get-all-columns() !global;
+$flint__all-keys: flint-get-all-keys() !global;
+$flint__all-breakpoints: flint-get-all-breakpoints() !global;
+$flint__all-columns: flint-get-all-columns() !global;
 
 /*
- * Keep track of all instances of mixin
+ * Keep count of all instances
+ *
+ * @access private
+ *
+ * @type {Number}
  */
 $flint__instance-count: 0 !global;
+
+/*
+ * Keep map of all instances
+ *
+ * @access private
+ *
+ * @type {Map}
+ */
 $flint__instances: () !global;
 
 /*
  * Font size for em calculation
+ *
+ * @access private
+ *
+ * @type {Number}
  */
 $flint__base-font-size: 16px !global;
 
 /*
  * Global syntax support
+ *
+ * @access private
+ *
+ * @type {String}
  */
 $flint__support-syntax: flint-get-value("settings", "support-syntax") !global;
 
 /*
  * Detect if Ruby functions are available
+ *
+ * @access private
+ *
+ * @type {Bool}
  */
 $flint__use-ruby-functions: if(flint-use-ruby-functions() == true, true, false) !global;
 
 /*
- * Cached selector instance lists
+ * Cache selector instance lists
+ *
+ * @access private
+ *
+ * @type {Map}
  */
 $flint__cached-instances: () !global;
 
 /*
- * Cached calculated values
+ * Cache calculated values
+ *
+ * @access private
+ *
+ * @type {Map}
  */
 $flint__cached-values: () !global;
 
 /*
- * hached calculation results
+ * Cache calculation results
+ *
+ * @access private
+ *
+ * @type {Map}
  */
 $flint__cache-results: () !global;

data/stylesheets/flint/mixins/lib/_box-sizing.scss

@@ -1,6 +1,8 @@
 /**
  * Box sizing
  *
+ * @access private
+ *
  * @param {String} $type ("border-box") - border-box type
  *
  * @requires local box-sizing mixin if available

data/stylesheets/flint/mixins/lib/_calculate.scss

@@ -1,9 +1,11 @@
 /**
  * Outputs calculated styles
  *
- * @param {Number} $width
- * @param {Number} $margin-right
- * @param {Number} $margin-left
+ * @access private
+ *
+ * @param {Map}    $width        - map of target / context values
+ * @param {Number} $margin-right - right margin value
+ * @param {Number} $margin-left  - left margin value
  */
 @mixin flint-output($width, $margin-right, $margin-left) {
 
@@ -29,6 +31,8 @@
 /**
  * Calculate widths, save all variables to instance
  *
+ * @access private
+ *
  * @param {String}        $calc-key     - breakpoint key
  * @param {Number}        $calc-span    - span value
  * @param {Number}        $calc-context - context value
@@ -57,9 +61,9 @@
 	/*
 	 * Check lengths, if invalid throw error
 	 */
-	@if flint-types-in-list($calc-gutter, "string") and length($calc-gutter) != length($flint__all__keys) {
+	@if flint-types-in-list($calc-gutter, "string") and length($calc-gutter) != length($flint__all-keys) {
 		@if not $flint__development-mode {
-			@error "Invalid argument length of #{length($calc-gutter)} for gutter. If you're using a shorthand, please provide an argument for each breakpoint in your config (#{length($flint__all__keys)}). Your argument was: #{$calc-gutter}";
+			@error "Invalid argument length of #{length($calc-gutter)} for gutter. If you're using a shorthand, please provide an argument for each breakpoint in your config (#{length($flint__all-keys)}). Your argument was: #{$calc-gutter}";
 		}
 	}
 

data/stylesheets/flint/mixins/lib/_clearfix.scss

@@ -1,6 +1,8 @@
 /**
  * Micro flint-clearfix
  *
+ * @access private
+ *
  * @link http://nicolasgallagher.com/micro-clearfix-hack/
  *
  * @requires local clearfix mixin if available

data/stylesheets/flint/mixins/lib/_container.scss

@@ -1,6 +1,8 @@
 /**
  * Container
  *
+ * @access private
+ *
  * @param {String} $key (null) - alias of individual breakpoint
  * @param {Number} $i   (null) - index number if called from loop
  */

data/stylesheets/flint/mixins/lib/_main.scss

@@ -1,10 +1,15 @@
 /**
  * Main API
  *
+ * @access public
+ *
  * @param {String | Number | List} $key     - key of breakpoint or shorthand span
  * @param {String | Number | List} $span    - value of span of column or shorthand context
- * @param {Number | List}          $context - context value of span
+ * @param {String | Number | List} $context - context value of span
  * @param {String | List}          $gutter  - alias for gutter modifier
+ *
+ * @author Ezekiel Gabrielse
+ * @link http://flint.gs
  */
 @mixin _(
     $key: null,
@@ -19,6 +24,9 @@
      *   else falls back to packaged.
      *
      * @param {String}
+     *
+     * @example scss
+     * _(clear)
      */
     @if $key == "clear" or $span == "clear" or $context == "clear" {
 
@@ -68,6 +76,9 @@
      *   else falls back to packaged.
      *
      * @param {String}
+     *
+     * @example scss
+     * _(foundation)
      */
     @if $key == "foundation" {
 
@@ -90,6 +101,9 @@
      * Container instance
      *
      * @param {String}
+     *
+     * @example scss
+     * _(container)
      */
     } @else if $key == "container" or $span == "container" or $context == "container" {
 
@@ -103,7 +117,7 @@
          */
         @if $key == "container" and flint-get-value("settings", "grid") == "fixed" {
 
-            @for $i from 1 through length($flint__all__keys) {
+            @for $i from 1 through length($flint__all-keys) {
 
                 // Set up variables
                 $calc-key: flint-steal-key($i);
@@ -196,10 +210,13 @@
         }
 
         /**
-         * Recursive shorthand with identical context
+         * Recursive shorthand with no context
          *
          * @param {Number} $key  - single span value for all breakpoints
          * @param {Null}   $span - null context value
+         *
+         * @example scss
+         * _(2)
          */
         @if flint-is-number($key) and length($key) == 1 and $span == null
 
@@ -208,6 +225,9 @@
          *
          * @param {Number}          $key  - single span value for all breakpoints
          * @param {Number | String} $span - single context value for all breakpoints
+         *
+         * @example scss
+         * _(2, 4)
          */
         or flint-is-number($key) and length($key) == 1 and flint-is-number($span) and length($span) == 1
         or flint-is-number($key) and length($key) == 1 and $span == "auto"
@@ -218,6 +238,9 @@
          * @param {Number}        $key  - single span value for all breakpoints
          * @param {List | String} $span - context value of span for each breakpoint
          *
+         * @example scss
+         * _(1, 2 4 6 8) | _(1, auto)
+         *
          * @throws error if lengths do not match number of breakpoints
          */
         or flint-is-number($key) and length($key) == 1 and flint-types-in-list($span, "number")
@@ -229,6 +252,9 @@
          * @param {List} $key  - span value for each breakpoint
          * @param {Null} $span - null context value
          *
+         * @example scss
+         * _(1 2 3 4)
+         *
          * @throws error if lengths do not match number of breakpoints
          */
         or flint-types-in-list($key, "number") and $span == null
@@ -237,7 +263,10 @@
          * Variable shorthand with context
          *
          * @param {List} $key  - span value for each breakpoint
-         * @param {List} $span - context value for each breakpoint
+         * @param {List | String} $span - context value for each breakpoint
+         *
+         * @example scss
+         * _(1 2 3 4, 2 4 6 8) | _(1 2 3 4, auto)
          *
          * @throws error if lengths do not match number of breakpoints
          */
@@ -245,17 +274,17 @@
         or flint-types-in-list($key, "number") and $span == "auto" {
 
             // Emit erroring for invalid argument lengths
-            @if flint-types-in-list($key, "number") and length($key) != length($flint__all__keys) {
+            @if flint-types-in-list($key, "number") and length($key) != length($flint__all-keys) {
                 @if not $flint__development-mode {
-                    @error "Invalid argument length of #{length($key)} for span. Please provide an argument for each breakpoint in your config (#{length($flint__all__keys)}). Your argument was: #{$key}";
+                    @error "Invalid argument length of #{length($key)} for span. Please provide an argument for each breakpoint in your config (#{length($flint__all-keys)}). Your argument was: #{$key}";
                 }
-            } @else if flint-types-in-list($span, "number") and length($span) != length($flint__all__keys) {
+            } @else if flint-types-in-list($span, "number") and length($span) != length($flint__all-keys) {
                 @if not $flint__development-mode {
-                    @error "Invalid argument length of #{length($span)} for context. Please provide an argument for each breakpoint in your config (#{length($flint__all__keys)}). Your argument was: #{$span}";
+                    @error "Invalid argument length of #{length($span)} for context. Please provide an argument for each breakpoint in your config (#{length($flint__all-keys)}). Your argument was: #{$span}";
                 }
             } @else {
 
-                @for $i from 1 through length($flint__all__keys) {
+                @for $i from 1 through length($flint__all-keys) {
 
                     $calc-key: flint-steal-key($i);
                     $calc-span: $key;
@@ -326,17 +355,23 @@
          * @param {Number} $span    - span value for breakpoint
          * @param {Null}   $context - null context value
          *
+         * @example scss
+         * _(desktop, 2)
+         *
          * @throws error if breakpoint alias does not exist
          */
         } @else if flint-is-string($key) and flint-is-number($span) and $context == null
 
         /**
-         * all by alias with context
+         * Call by alias with context
          *
          * @param {String}          $key     - breakpoint alias
          * @param {Number}          $span    - span value for breakpoint
          * @param {Number | String} $context - context value for breakpoint
          *
+         * @example scss
+         * _(desktop, 2, 4)
+         *
          * @throws error if breakpoint alias does not exist
          */
         or flint-is-string($key) and flint-is-number($span) and flint-is-number($context)

data/stylesheets/flint/mixins/lib/_new-instance.scss

@@ -1,6 +1,8 @@
 /**
  * Creates a new instance, adds to global instance map
  *
+ * @access private
+ *
  * @param {String} $calc-key
  * @param {Number} $calc-span
  * @param {Number} $calc-context

data/stylesheets/flint/mixins/lib/_print-instance.scss

@@ -1,6 +1,8 @@
 /**
  * Prints debug properties
  *
+ * @access private
+ *
  * @param {String} $calc-key - breakpoint key to search for instance
  */
 @mixin flint-debug-instance($calc-key) {
@@ -16,6 +18,8 @@
 /**
  * Prints all contents of instance map
  *
+ * @access private
+ *
  * @param {Map} $instance - instance map
  */
 @mixin flint-print-instance($instance) {

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: flint-gs
 version: !ruby/object:Gem::Version
-  version: 2.0.0.rc.1
+  version: 2.0.0.rc.2
 platform: ruby
 authors:
 - Ezekiel Gabrielse
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-09-12 00:00:00.000000000 Z
+date: 2014-09-16 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: sass
@@ -24,7 +24,7 @@ dependencies:
     - - ~>
       - !ruby/object:Gem::Version
         version: '3.3'
-description: Flint is a highly advanced Sass grid system designed for rapid responsive
+description: Flint is a highly advanced Sass grid framework designed for rapid responsive
   development.
 email:
 - ezekg@yahoo.com
@@ -95,5 +95,5 @@ rubyforge_project: flint
 rubygems_version: 2.0.14
 signing_key: 
 specification_version: 4
-summary: A powerful Sass grid-system designed for complex responsive layouts.
+summary: A highly advanced Sass grid framework designed for rapid responsive development.
 test_files: []