Fix typo in notmuch.h documentation regarding database open modes
authorMichael Forney <michael@obberon.com>
Fri, 26 Mar 2010 18:39:17 +0000 (18:39 +0000)
committerCarl Worth <cworth@cworth.org>
Tue, 13 Apr 2010 15:39:10 +0000 (08:39 -0700)
Reviewed-by: Carl Worth <cworth@cworth.org>:
The original proposal for having different open modes used the name
WRITABLE. I didn't like that name, (easy to misspell as WRITEABLE even
for native English speakers). So we renamed it to READ_WRITE
immediately, but apparently some of the documentation held the old
name for a while.

lib/notmuch.h

index 426828542bcf50fc6dfa4f2908ec2c0ac7ba6b57..a7e66dd35c9e69bfa8882b8b2b27b8aee8d99a97 100644 (file)
@@ -156,7 +156,7 @@ typedef enum {
  * (not necessarily by this process), by calling
  * notmuch_database_create with 'path'. By default the database should be
  * opened for reading only. In order to write to the database you need to
  * (not necessarily by this process), by calling
  * notmuch_database_create with 'path'. By default the database should be
  * opened for reading only. In order to write to the database you need to
- * pass the NOTMUCH_DATABASE_MODE_WRITABLE mode.
+ * pass the NOTMUCH_DATABASE_MODE_READ_WRITE mode.
  *
  * An existing notmuch database can be identified by the presence of a
  * directory named ".notmuch" below 'path'.
  *
  * An existing notmuch database can be identified by the presence of a
  * directory named ".notmuch" below 'path'.