X-Git-Url: https://git.notmuchmail.org/git?a=blobdiff_plain;f=lib%2Fnotmuch.h;h=974be8d1bec2fb52fb5e8ca8452b9f10a5521479;hb=f4dae4e5a199c843cfe139f1c1496eac3e1d120e;hp=4295cbd09e0d626409869ed548b80c17fe2e000d;hpb=5a98880add247cca406cc99bf826398915ee6039;p=notmuch

diff --git a/lib/notmuch.h b/lib/notmuch.h
index 4295cbd0..974be8d1 100644
--- a/lib/notmuch.h
+++ b/lib/notmuch.h
@@ -103,7 +103,7 @@ typedef enum _notmuch_status {
 
 /* Get a string representation of a notmuch_status_t value.
  *
- * The result is readonly.
+ * The result is read-only.
  */
 const char *
 notmuch_status_to_string (notmuch_status_t status);
@@ -510,7 +510,7 @@ notmuch_threads_move_to_next (notmuch_threads_t *threads);
  *
  * It's not strictly necessary to call this function. All memory from
  * the notmuch_threads_t object will be reclaimed when the
- * containg query object is destroyed.
+ * containing query object is destroyed.
  */
 void
 notmuch_threads_destroy (notmuch_threads_t *threads);
@@ -926,11 +926,8 @@ notmuch_message_remove_all_tags (notmuch_message_t *message);
  * For each flag that is not present, the opposite action (add/remove)
  * is performed for the corresponding tags.
  *
- * The only filenames examined for flags are filenames which appear to
- * be within a maildir directory, (the file must be in a directory
- * named "new" or "cur" and there must be a neighboring directory
- * named respectively "cur" or "new"). The flags are identified as
- * trailing components of the filename after a sequence of ":2,".
+ * Flags are identified as trailing components of the filename after a
+ * sequence of ":2,".
  *
  * If there are multiple filenames associated with this message, the
  * flag is considered present if it appears in one or more
@@ -950,10 +947,11 @@ notmuch_message_maildir_flags_to_tags (notmuch_message_t *message);
  *
  * Specifically, for each filename corresponding to this message:
  *
- * If the filename is not in a maildir directory, do nothing.
- * (A maildir directory is determined as a directory named "new" or
- * "cur" with a neighboring directory named respectively "cur" or
- * "new".)
+ * If the filename is not in a maildir directory, do nothing.  (A
+ * maildir directory is determined as a directory named "new" or
+ * "cur".) Similarly, if the filename has invalid maildir info,
+ * (repeated or outof-ASCII-order flag characters after ":2,"), then
+ * do nothing.
  *
  * If the filename is in a maildir directory, rename the file so that
  * its filename ends with the sequence ":2," followed by zero or more
@@ -965,8 +963,8 @@ notmuch_message_maildir_flags_to_tags (notmuch_message_t *message);
  *   'R' iff the message has the "replied" tag
  *   'S' iff the message does not have the "unread" tag
  *
- * Any existing flags unmentioned in the list above are left
- * unaffected by the rename.
+ * Any existing flags unmentioned in the list above will be preserved
+ * in the renaming.
  *
  * Also, if this filename is in a directory named "new", rename it to
  * be within the neighboring directory named "cur".