Skip to content

Commit 840fc77

Browse files
committed
update .clear() docs
1 parent d9fb19b commit 840fc77

File tree

2 files changed

+2
-2
lines changed

2 files changed

+2
-2
lines changed

docs/API.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -105,7 +105,7 @@ Returns raw data direct from the underlying [jsdoc3](https://github.com/jsdoc3/j
105105
<a name="module_jsdoc-to-markdown--JsdocToMarkdown+clear"></a>
106106

107107
### jsdoc2md.clear() ⇒ <code>Promise</code>
108-
Clear the cache.
108+
Clear the cache. By default, the cache is stored in the [system tmpdir](https://nodejs.org/dist/latest-v6.x/docs/api/os.html#os_os_tmpdir). MacOS clears out this directory every few days (meaning your jsdoc2md cache will be cleaned automatically).
109109

110110
**Kind**: instance method of <code>[JsdocToMarkdown](#exp_module_jsdoc-to-markdown--JsdocToMarkdown)</code>
111111
**Category**: async

src/lib/jsdoc-to-markdown.js

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -135,7 +135,7 @@ class JsdocToMarkdown {
135135
}
136136

137137
/**
138-
* Clear the cache.
138+
* Clear the cache. By default, the cache is stored in the [system tmpdir](https://nodejs.org/dist/latest-v6.x/docs/api/os.html#os_os_tmpdir). MacOS clears out this directory every few days (meaning your jsdoc2md cache will be cleaned automatically).
139139
* @returns {Promise}
140140
* @category async
141141
*/

0 commit comments

Comments
 (0)