Merge pull request #3 from brainrape/add-docs

add docs

Author: paf31

README.md

@@ -2,59 +2,221 @@
 
 ## Module Math
 
-### Types
 
-    type Radians  = Number
+Wraps the math functions and constants from Javascript's built-in `Math` object.
+See [Math Reference at MDN](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Math).
 
+#### `Radians`
 
-### Values
+``` purescript
+type Radians = Number
+```
 
-    abs :: Number -> Number
+An alias to make types in this module more explicit.
 
-    acos :: Number -> Radians
+#### `abs`
 
-    asin :: Number -> Radians
+``` purescript
+abs :: Number -> Number
+```
 
-    atan :: Number -> Radians
+Returns the absolute value of the argument.
 
-    atan2 :: Number -> Number -> Radians
+#### `acos`
 
-    ceil :: Number -> Number
+``` purescript
+acos :: Number -> Radians
+```
 
-    cos :: Radians -> Number
+Returns the inverse cosine of the argument.
 
-    e :: Number
+#### `asin`
 
-    exp :: Number -> Number
+``` purescript
+asin :: Number -> Radians
+```
 
-    floor :: Number -> Number
+Returns the inverse sine of the argument.
 
-    ln10 :: Number
+#### `atan`
 
-    ln2 :: Number
+``` purescript
+atan :: Number -> Radians
+```
 
-    log :: Number -> Number
+Returns the inverse tangent of the argument.
 
-    log10e :: Number
+#### `atan2`
 
-    log2e :: Number
+``` purescript
+atan2 :: Number -> Number -> Radians
+```
 
-    max :: Number -> Number -> Number
+Four-quadrant tangent inverse. Given the arguments `y` and `x`, returns
+the inverse tangent of `y / x`, where the signs of both arguments are used
+to determine the sign of the result.
+If the first argument is negative, the result will be negative.
+The result is the angle between the positive x axis and  a point `(x, y)`.
 
-    min :: Number -> Number -> Number
+#### `ceil`
 
-    pi :: Number
+``` purescript
+ceil :: Number -> Number
+```
 
-    pow :: Number -> Number -> Number
+Returns the smallest integer not smaller than the argument.
 
-    round :: Number -> Number
+#### `cos`
 
-    sin :: Radians -> Number
+``` purescript
+cos :: Radians -> Number
+```
 
-    sqrt :: Number -> Number
+Returns the cosine of the argument.
+
+#### `exp`
+
+``` purescript
+exp :: Number -> Number
+```
+
+Returns `e` exponentiated to the power of the argument.
+
+#### `floor`
+
+``` purescript
+floor :: Number -> Number
+```
+
+Returns the largest integer not larger than the argument.
+
+#### `log`
+
+``` purescript
+log :: Number -> Number
+```
+
+Returns the natural logarithm of a number.
+
+#### `max`
+
+``` purescript
+max :: Number -> Number -> Number
+```
+
+Returns the largest of two numbers.
+
+#### `min`
+
+``` purescript
+min :: Number -> Number -> Number
+```
+
+Returns the smallest of two numbers.
+
+#### `pow`
+
+``` purescript
+pow :: Number -> Number -> Number
+```
+
+Return  the first argument exponentiated to the power of the second argument.
+
+#### `round`
+
+``` purescript
+round :: Number -> Number
+```
+
+Returns the integer closest to the argument.
+
+#### `sin`
+
+``` purescript
+sin :: Radians -> Number
+```
+
+Returns the sine of the argument.
+
+#### `sqrt`
+
+``` purescript
+sqrt :: Number -> Number
+```
+
+Returns the square root of the argument.
+
+#### `tan`
+
+``` purescript
+tan :: Radians -> Number
+```
+
+Returns the tangent of the argument.
+
+#### `e`
+
+``` purescript
+e :: Number
+```
+
+The base of natural logarithms, *e*, around 2.71828.
+
+#### `ln2`
+
+``` purescript
+ln2 :: Number
+```
+
+The natural logarithm of 2, around 0.6931.
+
+#### `ln10`
+
+``` purescript
+ln10 :: Number
+```
+
+The natural logarithm of 10, around 2.3025.
+
+#### `log2e`
+
+``` purescript
+log2e :: Number
+```
+
+The base 2 logarithm of `e`, around 1.4426.
+
+#### `log10e`
+
+``` purescript
+log10e :: Number
+```
+
+Base 10 logarithm of `e`, around 0.43429.
+
+#### `pi`
+
+``` purescript
+pi :: Number
+```
+
+The ratio of the circumference of a circle to its diameter, around 3.14159.
+
+#### `sqrt1_2`
+
+``` purescript
+sqrt1_2 :: Number
+```
+
+The Square root of one half, around 0.707107.
+
+#### `sqrt2`
+
+``` purescript
+sqrt2 :: Number
+```
+
+The square root of two, around 1.41421.
 
-    sqrt1_2 :: Number
 
-    sqrt2 :: Number
 
-    tan :: Radians -> Number

src/Math.purs

@@ -1,66 +1,105 @@
+-- | Wraps the math functions and constants from Javascript's built-in `Math` object.
+-- | See [Math Reference at MDN](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Math).
 module Math where
 
+-- | An alias to make types in this module more explicit.
 type Radians = Number
 
+-- | Returns the absolute value of the argument.
 foreign import abs "var abs = Math.abs;" :: Number -> Number
 
+-- | Returns the inverse cosine of the argument.
 foreign import acos "var acos = Math.acos;" :: Number -> Radians
 
+-- | Returns the inverse sine of the argument.
 foreign import asin "var asin = Math.asin;" :: Number -> Radians
 
+-- | Returns the inverse tangent of the argument.
 foreign import atan "var atan = Math.atan;" :: Number -> Radians
 
+-- | Four-quadrant tangent inverse. Given the arguments `y` and `x`, returns
+-- | the inverse tangent of `y / x`, where the signs of both arguments are used
+-- | to determine the sign of the result.
+-- | If the first argument is negative, the result will be negative.
+-- | The result is the angle between the positive x axis and  a point `(x, y)`.
 foreign import atan2
   "function atan2(y){\
   \  return function (x) {\
   \    return Math.atan2(y, x);\
   \  };\
   \}" :: Number -> Number -> Radians
 
+-- | Returns the smallest integer not smaller than the argument.
 foreign import ceil "var ceil = Math.ceil;" :: Number -> Number
 
+-- | Returns the cosine of the argument.
 foreign import cos "var cos = Math.cos;" :: Radians -> Number
 
+-- | Returns `e` exponentiated to the power of the argument.
 foreign import exp "var exp = Math.exp;" :: Number -> Number
 
+-- | Returns the largest integer not larger than the argument.
 foreign import floor "var floor = Math.floor;" :: Number -> Number
 
+-- | Returns the natural logarithm of a number.
 foreign import log "var log = Math.log;" :: Number -> Number
 
+-- | Returns the largest of two numbers.
 foreign import max
   "function max(n1){\
   \  return function(n2) {\
   \    return Math.max(n1, n2);\
   \  }\
   \}" :: Number -> Number -> Number
 
+-- | Returns the smallest of two numbers.
 foreign import min
   "function min(n1){\
   \  return function(n2) {\
   \    return Math.min(n1, n2);\
   \  }\
   \}" :: Number -> Number -> Number
 
+-- | Return  the first argument exponentiated to the power of the second argument.
 foreign import pow
   "function pow(n){\
   \  return function(p) {\
   \    return Math.pow(n, p);\
   \  }\
   \}" :: Number -> Number -> Number
 
+-- | Returns the integer closest to the argument.
 foreign import round "var round = Math.round;" :: Number -> Number
 
+-- | Returns the sine of the argument.
 foreign import sin "var sin = Math.sin;" :: Radians -> Number
 
+-- | Returns the square root of the argument.
 foreign import sqrt "var sqrt = Math.sqrt;" :: Number -> Number
 
+-- | Returns the tangent of the argument.
 foreign import tan "var tan = Math.tan;" :: Radians -> Number
 
+-- | The base of natural logarithms, *e*, around 2.71828.
 foreign import e       "var e       = Math.E;"       :: Number
+
+-- | The natural logarithm of 2, around 0.6931.
 foreign import ln2     "var ln2     = Math.LN2;"     :: Number
+
+-- | The natural logarithm of 10, around 2.3025.
 foreign import ln10    "var ln10    = Math.LN10;"    :: Number
+
+-- | The base 2 logarithm of `e`, around 1.4426.
 foreign import log2e   "var log2e   = Math.LOG2E;"   :: Number
+
+-- | Base 10 logarithm of `e`, around 0.43429.
 foreign import log10e  "var log10e  = Math.LOG10E;"  :: Number
+
+-- | The ratio of the circumference of a circle to its diameter, around 3.14159.
 foreign import pi      "var pi      = Math.PI;"      :: Number
+
+-- | The Square root of one half, around 0.707107.
 foreign import sqrt1_2 "var sqrt1_2 = Math.SQRT1_2;" :: Number
+
+-- | The square root of two, around 1.41421.
 foreign import sqrt2   "var sqrt2   = Math.SQRT2;"   :: Number