doc: forbid further operations on a closed database
authorDavid Bremner <david@tethera.net>
Mon, 27 Jun 2016 18:38:40 +0000 (20:38 +0200)
committerDavid Bremner <david@tethera.net>
Tue, 28 Jun 2016 21:20:38 +0000 (23:20 +0200)
We could add many null pointer checks, but currently I don't see a use
case that justifies it.

lib/notmuch.h

index d4a97cb819de3fcb168e9c56574975aa0dcaeff8..2faa146838c32e48214e50e3649a00c098442779 100644 (file)
@@ -332,7 +332,9 @@ notmuch_database_status_string (const notmuch_database_t *notmuch);
  * functions on objects derived from this database may either behave
  * as if the database had not been closed (e.g., if the required data
  * has been cached) or may fail with a
- * NOTMUCH_STATUS_XAPIAN_EXCEPTION.
+ * NOTMUCH_STATUS_XAPIAN_EXCEPTION. The only further operation
+ * permitted on the database itself is to call
+ * notmuch_database_destroy.
  *
  * notmuch_database_close can be called multiple times.  Later calls
  * have no effect.