[PATCH] Update documentation of notmuch_query_create

[PATCH] Update documentation of notmuch_query_create

[Fernando Carrijo]

Commit cd467caf renamed notmuch_query_search to notmuch_query_search_messages.                                                
Commit 1ba3d46f created notmuch_query_search_threads. We better keep the docs                                                 
of notmuch_query_create consistent with those changes.                                                                        

                                                                                                                              
Signed-off-by: Fernando Carrijo <fcarrijo@yahoo.com.br>                                                                       
---
 lib/notmuch.h |    3 ++-                                                                                                     
 1 files changed, 2 insertions(+), 1 deletions(-)                                                                             
                                                                                                                              
diff --git a/lib/notmuch.h b/lib/notmuch.h                                                                                    
index 60834fb..32ab199 100644                                                                                                 
--- a/lib/notmuch.h                                                                                                           
+++ b/lib/notmuch.h                                                                                                           
@@ -305,7 +305,8 @@ notmuch_database_get_all_tags (notmuch_database_t *db);
  * result in a query that returns all messages in the database.                                                              
  *                                                                                                                           
  * See notmuch_query_set_sort for controlling the order of results and                                                       
- * notmuch_query_search to actually execute the query.                                                                       
+ * notmuch_query_search_{messages,threads} to actually execute the                                                           
+ * query.                                                                                                                    
  *                                                                                                                           
  * User should call notmuch_query_destroy when finished with this                                                            
  * query.                                                                                                                    
--                                                                                                                            
1.5.6.3

Re: [PATCH] Update documentation of notmuch_query_create

[Carl Worth]

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

On Sat, 05 Dec 2009 12:22:05 -0200, Fernando Carrijo <fcarrijo@yahoo.com.br> wrote:
> Commit cd467caf renamed notmuch_query_search to notmuch_query_search_messages.                                                
> Commit 1ba3d46f created notmuch_query_search_threads. We better keep the docs                                                 
> of notmuch_query_create consistent with those changes.                                                                        

Thanks!

I had trouble applying the patch, (perhaps you performed a copy/paste
operation into your email program that added a bunch of trailing
whitespace?). But I fixed that and while at it, edited the comment so
that the full name of each referenced function appears. (The idea being
that I want grep to find these occurrences if they need to be updated
again in the future).

-Carl

[-- Attachment #2: Type: application/pgp-signature, Size: 189 bytes --]

Re: [PATCH] Update documentation of notmuch_query_create

[Fernando Carrijo]

Carl Worth <cworth@cworth.org> wrote:
> On Sat, 05 Dec 2009 12:22:05 -0200, Fernando Carrijo <fcarrijo@yahoo.com.br> wrote:
> > Commit cd467caf renamed notmuch_query_search to notmuch_query_search_messages.                                                
> > Commit 1ba3d46f created notmuch_query_search_threads. We better keep the docs                                                 
> > of notmuch_query_create consistent with those changes.                                                                        
> 
> Thanks!
> 
> I had trouble applying the patch, (perhaps you performed a copy/paste
> operation into your email program that added a bunch of trailing
> whitespace?).

Sorry for that. At the time I sent the patch I was using, for the lack
of a better euphemism, a memory unconscious  mail client which used to
get me distracted from those caracter conversion issues whenever I saw
some other applications being shot by the OOM killer. Seriously.

I won't let it happen again.

> But I fixed that and while at it, edited the comment so
> that the full name of each referenced function appears. (The idea being
> that I want grep to find these occurrences if they need to be updated
> again in the future).

Yes, it makes sense.

> -Carl

Thank you.