mirror of
https://git.notmuchmail.org/git/notmuch
synced 2024-12-22 09:24:54 +01:00
Clarify documentation and error string for NOTMUCH_STATUS_TAG_TOO_LONG
It's helpful to point out NOTMUCH_STATUS_TAG_MAX for users.
This commit is contained in:
parent
68a10091d6
commit
5ebb21600e
2 changed files with 5 additions and 4 deletions
|
@ -43,7 +43,7 @@ notmuch_status_to_string (notmuch_status_t status)
|
|||
case NOTMUCH_STATUS_NULL_POINTER:
|
||||
return "Erroneous NULL pointer";
|
||||
case NOTMUCH_STATUS_TAG_TOO_LONG:
|
||||
return "Tag value is too long";
|
||||
return "Tag value is too long (exceeds NOTMUCH_TAG_MAX)";
|
||||
default:
|
||||
case NOTMUCH_STATUS_LAST_STATUS:
|
||||
return "Unknown error status value";
|
||||
|
|
|
@ -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);
|
||||
|
|
Loading…
Reference in a new issue