From: Michael Forney <michael@obberon.com>
Date: Fri, 26 Mar 2010 18:39:17 +0000 (+0000)
Subject: Fix typo in notmuch.h documentation regarding database open modes
X-Git-Tag: 0.2~63
X-Git-Url: https://git.notmuchmail.org/git?p=notmuch;a=commitdiff_plain;h=9ddde6eb14c126e314d90e2e08f213fb81f0457f;ds=inline

Fix typo in notmuch.h documentation regarding database open modes

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.
---

diff --git a/lib/notmuch.h b/lib/notmuch.h
index 42682854..a7e66dd3 100644
--- a/lib/notmuch.h
+++ b/lib/notmuch.h
@@ -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
- * 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'.