[PATCH] lib: notmuch_tags_get example was not updated to reflect api change

[PATCH] lib: notmuch_tags_get example was not updated to reflect api change

[Allan Wind]

---
 lib/notmuch.h |   21 +++++++++++----------
 1 files changed, 11 insertions(+), 10 deletions(-)

diff --git a/lib/notmuch.h b/lib/notmuch.h
index 7929fe7..5e6e449 100644
--- a/lib/notmuch.h
+++ b/lib/notmuch.h
@@ -941,21 +941,22 @@ notmuch_message_get_header (notmuch_message_t *message, const char *header);
  * Typical usage might be:
  *
  *     notmuch_message_t *message;
+ *     notmuch_status_t status;
  *     notmuch_tags_t *tags;
  *     const char *tag;
  *
- *     message = notmuch_database_find_message (database, message_id);
- *
- *     for (tags = notmuch_message_get_tags (message);
- *          notmuch_tags_valid (tags);
- *          notmuch_result_move_to_next (tags))
- *     {
- *         tag = notmuch_tags_get (tags);
- *         ....
+ *     status = notmuch_database_find_message (database, message_id, &message);
+ *     if(!status && message) {
+ *          for (tags = notmuch_message_get_tags (message);
+ *               notmuch_tags_valid (tags);
+ *               notmuch_result_move_to_next (tags))
+ *          {
+ *               tag = notmuch_tags_get (tags);
+ *               ....
+ *          }
+ *          notmuch_message_destroy (message);
  *     }
  *
- *     notmuch_message_destroy (message);
- *
  * Note that there's no explicit destructor needed for the
  * notmuch_tags_t object. (For consistency, we do provide a
  * notmuch_tags_destroy function, but there's no good reason to call
-- 
1.7.2.5

Re: [PATCH] lib: notmuch_tags_get example was not updated to reflect api change

[Jani Nikula]

[-- Attachment #1: Type: text/plain, Size: 1938 bytes --]

The subject should be about what this patch does, like "lib: update
notmuch_tags_get example to reflect api change"

On Jan 29, 2012 12:46 AM, "Allan Wind" <allan_wind@lifeintegrity.com> wrote:
>

And preferably you would describe here what the api change was.

> ---
>  lib/notmuch.h |   21 +++++++++++----------
>  1 files changed, 11 insertions(+), 10 deletions(-)
>
> diff --git a/lib/notmuch.h b/lib/notmuch.h
> index 7929fe7..5e6e449 100644
> --- a/lib/notmuch.h
> +++ b/lib/notmuch.h
> @@ -941,21 +941,22 @@ notmuch_message_get_header (notmuch_message_t
*message, const char *header);
>  * Typical usage might be:
>  *
>  *     notmuch_message_t *message;
> + *     notmuch_status_t status;
>  *     notmuch_tags_t *tags;
>  *     const char *tag;
>  *
> - *     message = notmuch_database_find_message (database, message_id);
> - *
> - *     for (tags = notmuch_message_get_tags (message);
> - *          notmuch_tags_valid (tags);
> - *          notmuch_result_move_to_next (tags))
> - *     {
> - *         tag = notmuch_tags_get (tags);
> - *         ....
> + *     status = notmuch_database_find_message (database, message_id,
&message);
> + *     if(!status && message) {
> + *          for (tags = notmuch_message_get_tags (message);
> + *               notmuch_tags_valid (tags);
> + *               notmuch_result_move_to_next (tags))
> + *          {
> + *               tag = notmuch_tags_get (tags);
> + *               ....
> + *          }
> + *          notmuch_message_destroy (message);
>  *     }
>  *
> - *     notmuch_message_destroy (message);
> - *
>  * Note that there's no explicit destructor needed for the
>  * notmuch_tags_t object. (For consistency, we do provide a
>  * notmuch_tags_destroy function, but there's no good reason to call
> --
> 1.7.2.5
>
> _______________________________________________
> notmuch mailing list
> notmuch@notmuchmail.org
> http://notmuchmail.org/mailman/listinfo/notmuch

[-- Attachment #2: Type: text/html, Size: 2679 bytes --]