added jsdoc example for maybe function

bjdixon · Oct 1, 2015 · ddf1375 · ddf1375
1 parent 7bf7d6f
commit ddf1375
Showing 1 changed file with 8 additions and 0 deletions.
diff --git a/src/xo.js b/src/xo.js
@@ -210,6 +210,14 @@
    * Takes a function and returns a function.
    * The returned function will not be called if supplied with null
    * or undefined arguments
+   * 
+   * @example
+   * var sum = function(a, b) {
+   *   return a + b;
+   * }
+   * var maybeSum = xo.maybe(sum);
+   * maybeSum(2, 3); // 5
+   * maybeSum(null, 3); // doesn't invoke sum
    *
    * @alias module:xo.maybe
    * @param {Function} fn