Skip to content

Commit 1069a8e

Browse files
committed
Update example
1 parent 7f8004f commit 1069a8e

File tree

1 file changed

+10
-2
lines changed
  • lib/node_modules/@stdlib/_tools/markdown/namespace-toc/lib

1 file changed

+10
-2
lines changed

lib/node_modules/@stdlib/_tools/markdown/namespace-toc/lib/index.js

Lines changed: 10 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -24,9 +24,13 @@
2424
* @module @stdlib/_tools/markdown/namespace-toc
2525
*
2626
* @example
27+
* var resolve = require( 'path' ).resolve;
2728
* var createTOC = require( '@stdlib/_tools/markdown/namespace-toc' );
2829
*
29-
* createTOC( onCreate );
30+
* var opts = {
31+
* 'dir': resolve( __dirname, '..' )
32+
* };
33+
* createTOC( opts, onCreate );
3034
*
3135
* function onCreate( error, res ) {
3236
* if ( error ) {
@@ -40,9 +44,13 @@
4044
* }
4145
*
4246
* @example
47+
* var resolve = require( 'path' ).resolve;
4348
* var createTOC = require( '@stdlib/_tools/markdown/namespace-toc' );
4449
*
45-
* var out = createTOC.sync();
50+
* var opts = {
51+
* 'dir': resolve( __dirname, '..' )
52+
* };
53+
* var out = createTOC.sync( opts );
4654
* // returns {...}
4755
*/
4856

0 commit comments

Comments
 (0)