docs: fix errors in render() and renderSync() examples

jsdoc2md · Oct 26, 2016 · 26629f2 · 26629f2
1 parent 22f97b6
commit 26629f2
Show file tree

Hide file tree

Showing 3 changed files with 7 additions and 7 deletions.
diff --git a/docs/API.md b/docs/API.md
@@ -60,7 +60,7 @@ Returns markdown documentation from jsdoc-annoted source code.
 **Example**  
 Pass in filepaths (`**` glob matching supported) of javascript source files:
 ```js
-> jsdoc2md.render('lib/*.js').then(console.log)
+> jsdoc2md.render({ files: 'lib/*.js' }).then(console.log)
 ```
 
 -
@@ -142,7 +142,7 @@ Sync version of [render](#module_jsdoc-to-markdown--JsdocToMarkdown+render).
 
 **Example**  
 ```js
-const docs = jsdoc2md.renderSync('lib/*.js')
+const docs = jsdoc2md.renderSync({ files: 'lib/*.js' })
 ```
 
 -

diff --git a/package.json b/package.json
@@ -31,13 +31,13 @@
     "core-js": "^2.4.1",
     "dmd": "^2.1.2",
     "feature-detect-es6": "^1.3.1",
-    "jsdoc-api": "^2.0.5",
+    "jsdoc-api": "^2.0.6",
     "jsdoc-parse": "^2.0.5",
-    "jsdoc2md-stats": "^1.0.3",
+    "jsdoc2md-stats": "^1.0.4",
     "walk-back": "^2.0.1"
   },
   "devDependencies": {
-    "babel-preset-es2015": "^6.16.0",
+    "babel-preset-es2015": "^6.18.0",
     "coveralls": "^2.11.14",
     "test-runner": "^0.2.5"
   },

diff --git a/src/lib/jsdoc-to-markdown.js b/src/lib/jsdoc-to-markdown.js
@@ -41,7 +41,7 @@ class JsdocToMarkdown {
    * @example
    * Pass in filepaths (`**` glob matching supported) of javascript source files:
    * ```js
-   * > jsdoc2md.render('lib/*.js').then(console.log)
+   * > jsdoc2md.render({ files: 'lib/*.js' }).then(console.log)
    * ```
    */
   render (options) {
@@ -63,7 +63,7 @@ class JsdocToMarkdown {
    * @engine nodejs >= 0.12
    * @category sync
    * @example
-   * const docs = jsdoc2md.renderSync('lib/*.js')
+   * const docs = jsdoc2md.renderSync({ files: 'lib/*.js' })
    */
   renderSync (options) {
     options = options || {}