Document Ui.Utils.Env.

gdotdesign · Jan 19, 2016 · c6cedb2 · c6cedb2
1 parent ac5ffda
commit c6cedb2
Show file tree

Hide file tree

Showing 2 changed files with 8 additions and 1 deletion.
diff --git a/elm-package.json b/elm-package.json
@@ -42,7 +42,8 @@
     "Ui.Helpers.Drag",
     "Ui.Helpers.Animation",
     "Ui.Helpers.Dropdown",
-    "Ui.Helpers.Intendable"
+    "Ui.Helpers.Intendable",
+    "Ui.Utils.Env"
   ],
   "dependencies": {
     "circuithub/elm-number-format": "1.0.2 <= v < 2.0.0",

diff --git a/source/Ui/Utils/Env.elm b/source/Ui/Utils/Env.elm
@@ -1,9 +1,15 @@
 module Ui.Utils.Env where
 
+{-| Module for interacting with the environment variables.
+
+@docs get
+-}
 import Json.Decode as Json
 import Native.Env
 import Debug
 
+{-| Gets the value of the given environment variable with a decoder and a
+default value. -}
 get : String -> a -> Json.Decoder a -> a
 get key default decoder =
   let