Docs

Author: paf31

README.md

@@ -2,16 +2,54 @@
 
 ## Module Global
 
-### Values
 
-    infinity :: Number
+This module defines types for some global Javascript functions
+and values.
 
-    isFinite :: Number -> Boolean
+#### `nan`
 
-    isNaN :: Number -> Boolean
+``` purescript
+nan :: Number
+```
 
-    nan :: Number
+Not a number (NaN)
 
-    readFloat :: String -> Number
+#### `isNaN`
 
-    readInt :: Number -> String -> Number
+``` purescript
+isNaN :: Number -> Boolean
+```
+
+Test whether a number is NaN
+
+#### `infinity`
+
+``` purescript
+infinity :: Number
+```
+
+Positive infinity
+
+#### `isFinite`
+
+``` purescript
+isFinite :: Number -> Boolean
+```
+
+Test whether a number is finite
+
+#### `readInt`
+
+``` purescript
+readInt :: Number -> String -> Number
+```
+
+Parse an integer from a `String` in the specified base
+
+#### `readFloat`
+
+``` purescript
+readFloat :: String -> Number
+```
+
+Parse a floating point value from a `String`

src/Global.purs

@@ -1,3 +1,6 @@
+-- | This module defines types for some global Javascript functions
+-- | and values.
+
 module Global
   ( nan
   , isNaN
@@ -7,14 +10,19 @@ module Global
   , readFloat
   ) where
 
+-- | Not a number (NaN)
 foreign import nan "var nan = NaN;" :: Number
 
+-- | Test whether a number is NaN
 foreign import isNaN :: Number -> Boolean
 
+-- | Positive infinity
 foreign import infinity "var infinity = Infinity;" :: Number
 
+-- | Test whether a number is finite
 foreign import isFinite :: Number -> Boolean
 
+-- | Parse an integer from a `String` in the specified base
 foreign import readInt
   """
   function readInt(radix) {
@@ -24,5 +32,6 @@ foreign import readInt
   }
   """ :: Number -> String -> Number
 
+-- | Parse a floating point value from a `String`
 foreign import readFloat "var readFloat = parseFloat;" :: String -> Number