lib/tag: handle NULL argument to notmuch_tags_valid

[notmuch] / lib / notmuch.h

diff --git a/lib/notmuch.h b/lib/notmuch.h
index 2e6ec2af1ae2a5054cd1516088764cc44557faa4..44263a6663262c6a65ef556658aba26cd8ec69f9 100644 (file)
--- a/lib/notmuch.h
+++ b/lib/notmuch.h
@@ -2262,6 +2262,9 @@ notmuch_message_properties_destroy (notmuch_message_properties_t *properties);
  * valid string. Whereas when this function returns FALSE,
  * notmuch_tags_get will return NULL.
  *
+ * It is acceptable to pass NULL for 'tags', in which case this
+ * function will always return FALSE.
+
  * See the documentation of notmuch_message_get_tags for example code
  * showing how to iterate over a notmuch_tags_t object.
  */