aboutsummaryrefslogtreecommitdiffhomepage
path: root/notmuch.h
diff options
context:
space:
mode:
authorGravatar Carl Worth <cworth@cworth.org>2009-10-23 14:34:21 -0700
committerGravatar Carl Worth <cworth@cworth.org>2009-10-23 14:36:38 -0700
commit5ebb21600e5d4e9441ff82b93ba1691149ccd909 (patch)
treeb5f03c8d499c1de67ce996b8d5352e56f2c8ae46 /notmuch.h
parent68a10091d6b2c29e996ee84040eecad487cb5e91 (diff)
Clarify documentation and error string for NOTMUCH_STATUS_TAG_TOO_LONG
It's helpful to point out NOTMUCH_STATUS_TAG_MAX for users.
Diffstat (limited to 'notmuch.h')
-rw-r--r--notmuch.h7
1 files changed, 4 insertions, 3 deletions
diff --git a/notmuch.h b/notmuch.h
index 2c290fda..f270e48d 100644
--- a/notmuch.h
+++ b/notmuch.h
@@ -67,7 +67,8 @@ typedef int notmuch_bool_t;
* NOTMUCH_STATUS_NULL_POINTER: The user erroneously passed a NULL
* pointer to a notmuch function.
*
- * NOTMUCH_STATUS_TAG_TOO_LONG: A tag value is too long.
+ * NOTMUCH_STATUS_TAG_TOO_LONG: A tag value is too long (exceeds
+ * NOTMUCH_TAG_MAX)
*
* NOTMUCH_STATUS_LAST_STATUS: Not an actual status value. Just a way
* to find out how many valid status values there are.
@@ -484,7 +485,7 @@ notmuch_message_get_thread_ids (notmuch_message_t *message);
* NOTMUCH_STATUS_NULL_POINTER: The 'tag' argument is NULL
*
* NOTMUCH_STATUS_TAG_TOO_LONG: The length of 'tag' is longer than
- * too long (exceeds NOTMUCH_TAG_MAX)
+ * too long (exceeds NOTMUCH_TAG_MAX)
*/
notmuch_status_t
notmuch_message_add_tag (notmuch_message_t *message, const char *tag);
@@ -498,7 +499,7 @@ notmuch_message_add_tag (notmuch_message_t *message, const char *tag);
* NOTMUCH_STATUS_NULL_POINTER: The 'tag' argument is NULL
*
* NOTMUCH_STATUS_TAG_TOO_LONG: The length of 'tag' is longer than
- * too long (exceeds NOTMUCH_TAG_MAX)
+ * too long (exceeds NOTMUCH_TAG_MAX)
*/
notmuch_status_t
notmuch_message_remove_tag (notmuch_message_t *message, const char *tag);