Skip to content

Commit c82fdbc

Browse files
committed
Clarify close() documentation (#197)
1 parent adfc39d commit c82fdbc

File tree

1 file changed

+1
-1
lines changed

1 file changed

+1
-1
lines changed

README.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -197,7 +197,7 @@ If no callback is passed, a promise is returned.
197197

198198
<code>close()</code> closes the underlying store. The callback will receive any error encountered during closing as the first argument.
199199

200-
You should always clean up your `levelup` instance by calling `close()` when you no longer need it to free up resources. A store cannot be opened by multiple instances of `levelup` simultaneously.
200+
A `levelup` instance has associated resources like file handles and locks. When you no longer need your `levelup` instance (for the remainder of your program) call `close()` to free up resources. The underlying store cannot be opened by multiple instances of `levelup` simultaneously.
201201

202202
If no callback is passed, a promise is returned.
203203

0 commit comments

Comments
 (0)