[Pkg-javascript-commits] [node-leveldown] 216/492: update docs to reflect new reality

Andrew Kelley andrewrk-guest at moszumanska.debian.org
Sun Jul 6 17:14:00 UTC 2014


This is an automated email from the git hooks/post-receive script.

andrewrk-guest pushed a commit to annotated tag rocksdb-0.10.1
in repository node-leveldown.

commit 3eda5efdd1e61d9311a029dd90373a598b940217
Author: Rod Vagg <rod at vagg.org>
Date:   Sun Feb 17 13:11:18 2013 +1100

    update docs to reflect new reality
---
 README.md | 16 ++++++++--------
 1 file changed, 8 insertions(+), 8 deletions(-)

diff --git a/README.md b/README.md
index 2380db8..077070b 100644
--- a/README.md
+++ b/README.md
@@ -19,7 +19,7 @@ The other major priority for API-change will be to make it as easy and natural t
 <a name="api"></a>
 ## API
 
-  * <a href="#createDatabase"><code><b>createDatabase()</b></code></a>
+  * <a href="#ctor"><code><b>leveldown()</b></code></a>
   * <a href="#createIterator"><code><b>createIterator()</b></code></a>
   * <a href="#leveldown_open"><code><b>leveldown#open()</b></code></a>
   * <a href="#leveldown_close"><code><b>leveldown#close()</b></code></a>
@@ -33,9 +33,11 @@ The other major priority for API-change will be to make it as easy and natural t
 
 
 --------------------------------------------------------
-<a name="createDatabase"></a>
-### leveldown.createDatabase()
-<code>createDatabase()</code> returns a new **LevelDOWN** instance.
+<a name="ctor"></a>
+### leveldown(location)
+<code>leveldown()</code> returns a new **LevelDOWN** instance. `location` is a String pointing to the LevelDB location to be opened.
+
+The `location` argument is available as a read-only property on the returned LevelUP instance.
 
 --------------------------------------------------------
 <a name="createIterator"></a>
@@ -67,10 +69,8 @@ The `options` object may contain:
 
 --------------------------------------------------------
 <a name="leveldown_open"></a>
-### leveldown#open(location, options, callback)
-<code>open()</code> is an instance method on an existing database object. `location` is a String pointing to the LevelDB location to be opened.
-
-The `location` argument is available as a read-only property on the returned LevelUP instance.
+### leveldown#open(options, callback)
+<code>open()</code> is an instance method on an existing database object.
 
 #### `options`
 

-- 
Alioth's /usr/local/bin/git-commit-notice on /srv/git.debian.org/git/pkg-javascript/node-leveldown.git



More information about the Pkg-javascript-commits mailing list