[PATCH 1/1] lib/notmuch: update example

[PATCH 1/1] lib/notmuch: update example

[Kevin Boulain]

Likely missed in 86cbd215e, when notmuch_query_search_messages_st was
renamed to notmuch_query_search_messages.
---
 lib/notmuch.h | 3 ++-
 1 file changed, 2 insertions(+), 1 deletion(-)

diff --git a/lib/notmuch.h b/lib/notmuch.h
index ce375c04..73e246e0 100644
--- a/lib/notmuch.h
+++ b/lib/notmuch.h
@@ -1172,7 +1172,8 @@ notmuch_query_search_threads_st (notmuch_query_t *query, notmuch_threads_t **out
  *
  *     query = notmuch_query_create (database, query_string);
  *
- *     for (messages = notmuch_query_search_messages (query);
+ *     notmuch_query_search_messages (query, &messages);
+ *     for (;
  *          notmuch_messages_valid (messages);
  *          notmuch_messages_move_to_next (messages))
  *     {

Re: [PATCH 1/1] lib/notmuch: update example

[David Bremner]

Kevin Boulain <kevin@boula.in> writes:

> Likely missed in 86cbd215e, when notmuch_query_search_messages_st was
> renamed to notmuch_query_search_messages.
> ---
>  lib/notmuch.h | 3 ++-
>  1 file changed, 2 insertions(+), 1 deletion(-)
>
> diff --git a/lib/notmuch.h b/lib/notmuch.h
> index ce375c04..73e246e0 100644
> --- a/lib/notmuch.h
> +++ b/lib/notmuch.h
> @@ -1172,7 +1172,8 @@ notmuch_query_search_threads_st (notmuch_query_t *query, notmuch_threads_t **out
>   *
>   *     query = notmuch_query_create (database, query_string);
>   *
> - *     for (messages = notmuch_query_search_messages (query);
> + *     notmuch_query_search_messages (query, &messages);
> + *     for (;
>   *          notmuch_messages_valid (messages);
>   *          notmuch_messages_move_to_next (messages))
>   *     {

Thanks for the documentation update, but I don't think we should
encourage people to ignore the status code. Perhaps something like

    if (notmuch_query_search_messages (query, &messages))
       return EXIT_FAILURE;
    for (;

[PATCH 1/1] lib/notmuch: update example

[Kevin Boulain]

Likely missed in 86cbd215e, when notmuch_query_search_messages_st was
renamed to notmuch_query_search_messages.
---

> I don't think we should encourage people to ignore the status code.

Makes sense, I wasn't too sure if the example was deliberately
minimal.

 lib/notmuch.h | 5 ++++-
 1 file changed, 4 insertions(+), 1 deletion(-)

diff --git a/lib/notmuch.h b/lib/notmuch.h
index ce375c04..89018392 100644
--- a/lib/notmuch.h
+++ b/lib/notmuch.h
@@ -1172,7 +1172,10 @@ notmuch_query_search_threads_st (notmuch_query_t *query, notmuch_threads_t **out
  *
  *     query = notmuch_query_create (database, query_string);
  *
- *     for (messages = notmuch_query_search_messages (query);
+ *     if (notmuch_query_search_messages (query, &messages) != NOTMUCH_STATUS_SUCCESS)
+ *         return EXIT_FAILURE;
+ *
+ *     for (;
  *          notmuch_messages_valid (messages);
  *          notmuch_messages_move_to_next (messages))
  *     {

Re: [PATCH 1/1] lib/notmuch: update example

[David Bremner]

Kevin Boulain <kevin@boula.in> writes:

> Likely missed in 86cbd215e, when notmuch_query_search_messages_st was
> renamed to notmuch_query_search_messages.
> ---

Applied to master, thanks.

d