lib: Document that absence of maildir flags can also remove/add tags
authorCarl Worth <cworth@cworth.org>
Thu, 11 Nov 2010 10:45:24 +0000 (02:45 -0800)
committerCarl Worth <cworth@cworth.org>
Thu, 11 Nov 2010 11:40:19 +0000 (03:40 -0800)
commit5a98880add247cca406cc99bf826398915ee6039
tree2c6709e91db5a09457a7abeb9b7a90461f87219e
parent0100df8edbc84d95210c369b9eb560b87c2d36be
lib: Document that absence of maildir flags can also remove/add tags

Previously the documentation of notmuch_message_maildir_flags_to_tags
suggested that the presence of a flag would cause tags to be added,
(or in the case of "unread", removed). But the case of absent maildir
flags was not explicitly described.

What we actually want, is that for supported flags, the absence of the
flag in all messages causes the corresponding tag to be removed,
(or in the case of "unread", added). So document that explicitly.

This is the case recently added to the test suite as a failing test,
(so we'll need to do bug fixing before the documentation is honest
here).
lib/notmuch.h