Skip to content

Commit 8b35cd2

Browse files
authored
Update docs (wbolster#132)
Fixed typos and pip usage
1 parent 9dbb8e4 commit 8b35cd2

File tree

4 files changed

+5
-5
lines changed

4 files changed

+5
-5
lines changed

Diff for: doc/api.rst

+2-2
Original file line numberDiff line numberDiff line change
@@ -27,7 +27,7 @@ LevelDB database.
2727
2828
Open the underlying database handle.
2929

30-
Most arguments have the same name as the the corresponding LevelDB
30+
Most arguments have the same name as the corresponding LevelDB
3131
parameters; see the LevelDB documentation for a detailed description.
3232
Arguments defaulting to `None` are only propagated to LevelDB if
3333
specified, e.g. not specifying a `write_buffer_size` means the LevelDB
@@ -85,7 +85,7 @@ LevelDB database.
8585

8686
Closing a database while other threads are busy accessing the same
8787
database may result in hard crashes, since database operations do not
88-
perform any synchronisation/locking on the database object (for
88+
perform any synchronization/locking on the database object (for
8989
performance reasons) and simply assume it is available (and open).
9090
Applications should make sure not to close databases that are
9191
concurrently used from other threads.

Diff for: doc/index.rst

+1-1
Original file line numberDiff line numberDiff line change
@@ -25,7 +25,7 @@ Plyvel's key features are:
2525
* **High performance**
2626

2727
Plyvel executes all performance-critical code at C speed (using Cython_),
28-
which means Plyvel is a good fit for high performance applications.
28+
which means Plyvel is a good fit for high-performance applications.
2929

3030
.. _Cython: http://cython.org/
3131

Diff for: doc/installation.rst

+1-1
Original file line numberDiff line numberDiff line change
@@ -78,7 +78,7 @@ If you see an ``ImportError`` complaining about undefined symbols, e.g.
7878
…then the installer (actually, the linker) was unable to find the LevelDB
7979
library on your system when building Plyvel. Install LevelDB or set the proper
8080
environment variables for the compiler and linker and try ``pip install
81-
--reinstall plyvel``.
81+
--upgrade --force-reinstall plyvel``.
8282

8383

8484
.. rubric:: Next steps

Diff for: doc/user.rst

+1-1
Original file line numberDiff line numberDiff line change
@@ -33,7 +33,7 @@ That's all there is to it. At this point ``/tmp/testdb/`` contains a fresh
3333
LevelDB database (assuming the directory did not contain a LevelDB database
3434
already).
3535

36-
For real world applications, you probably want to tweak things like the size of
36+
For real-world applications, you probably want to tweak things like the size of
3737
the memory cache and the number of bits to use for the (optional) bloom filter.
3838
These settings, and many others, can be specified as arguments to the
3939
:py:class:`DB` constructor. For this tutorial we'll just use the LevelDB

0 commit comments

Comments
 (0)