docs(api): update api docs

hybridables · Nov 1, 2016 · 8da7700 · 8da7700
1 parent aba375d
commit 8da7700
Show file tree

Hide file tree

Showing 2 changed files with 6 additions and 1 deletion.
diff --git a/README.md b/README.md
@@ -22,6 +22,9 @@
   * [tryCatchCore](#trycatchcore)
 - [Related](#related)
 - [Contributing](#contributing)
+- [Charlike Make Reagent](#charlike-make-reagent)
+
+_(TOC generated by [verb](https://github.com/verbose/verb) using [markdown-toc](https://github.com/jonschlinkert/markdown-toc))_
 
 ## Install
 ```
@@ -71,13 +74,14 @@ Guarantees. This package gives you guarantees that you will get correct result a
 
 ## API
 
-### [tryCatchCore](index.js#L70)
+### [tryCatchCore](index.js#L71)
 > Executes given `fn` and pass results/errors to the `callback` if given, otherwise returns a thunk.
 
 **Params**
 
 * `<fn>` **{Function}**: function to call    
 * `[cb]` **{Function}**: done callback to be used    
+* `[opts]` **{Object}**: optional options passed to [try-catch-callback][]    
 * `returns` **{Function}** `thunk`: only if `cb` is not a function  
 
 **Example**

diff --git a/index.js b/index.js
@@ -63,6 +63,7 @@ var utils = require('./utils')
  *
  * @param  {Function} `<fn>` function to call
  * @param  {Function} `[cb]` done callback to be used
+ * @param  {Object} `[opts]` optional options passed to [try-catch-callback][]
  * @return {Function} `thunk` only if `cb` is not a function
  * @api public
  */