Skip to content

Commit d2d0170

Browse files
committed
Docs cleanup
1 parent 35630ee commit d2d0170

1 file changed

Lines changed: 5 additions & 5 deletions

File tree

docs/compat.rst

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -41,7 +41,7 @@ The `.keys()` method returns a list of distinct keys from the database.
4141

4242
The `cdb` object keeps an iterator over the distinct keys of the database.
4343
The `.firstkey()` method resets the iterator and returns the first stored key.
44-
The `.nextkey()` advances the iterator and returns the next key.
44+
`.nextkey()` advances the iterator and returns the next key.
4545
After exhausting the iterator, `None` will be returned until `.firstkey()` is
4646
called again.
4747

@@ -91,9 +91,8 @@ Writing new databases
9191
---------------------
9292

9393
The `cdbmake()` class is used to create a new database. Call it with two
94-
file paths: the first is the ultimate location of the database.
95-
temporary location to use when creating the database.
96-
It will be moved to the ultimate location after completion.
94+
file paths: (1) the ultimate location of the database,
95+
(2) a temporary location to use when creating the database.
9796

9897
>>> cdb_path = '/tmp/info.cdb'
9998
>>> tmp_path = cdb_path + '.tmp'
@@ -128,7 +127,8 @@ It also decodes text data when reading:
128127
b'\x80 binary data'
129128

130129
`utf-8` encoding is used by default in `cdblib.compat.init()` and `cdblib.compat.cdbmake()`.
131-
Pass a different encoding with the `encoding` keyword argument to use a different scheme.
130+
Pass a different encoding with the `encoding` keyword argument.
131+
132132
Turn off automatic encoding or decoding by supplying `encoding=None`.
133133
All keys and values will be assumed to be `bytes` objects.
134134

0 commit comments

Comments
 (0)