* [PATCH] lib: Improve documentation of _notmuch_message_create_for_message_id
@ 2014-08-05 1:29 Austin Clements
2014-08-05 11:21 ` David Bremner
0 siblings, 1 reply; 2+ messages in thread
From: Austin Clements @ 2014-08-05 1:29 UTC (permalink / raw)
To: notmuch
Clarify the state of the returned message when
_notmuch_message_create_for_message_id returns
NOTMUCH_PRIVATE_STATUS_NO_DOCUMENT_FOUND.
---
lib/message.cc | 8 +++++---
1 file changed, 5 insertions(+), 3 deletions(-)
diff --git a/lib/message.cc b/lib/message.cc
index 8b17843..f8b346f 100644
--- a/lib/message.cc
+++ b/lib/message.cc
@@ -193,14 +193,16 @@ _notmuch_message_create (const void *talloc_owner,
* There is already a document with message ID 'message_id' in the
* database. The returned message can be used to query/modify the
* document.
+ *
* NOTMUCH_PRIVATE_STATUS_NO_DOCUMENT_FOUND:
*
* No document with 'message_id' exists in the database. The
* returned message contains a newly created document (not yet
* added to the database) and a document ID that is known not to
- * exist in the database. The caller can modify the message, and a
- * call to _notmuch_message_sync will add * the document to the
- * database.
+ * exist in the database. This message is "blank"; that is, it
+ * contains only a message ID and no other metadata. The caller
+ * can modify the message, and a call to _notmuch_message_sync
+ * will add the document to the database.
*
* If an error occurs, this function will return NULL and *status
* will be set as appropriate. (The status pointer argument must
--
2.0.0
^ permalink raw reply related [flat|nested] 2+ messages in thread
* Re: [PATCH] lib: Improve documentation of _notmuch_message_create_for_message_id
2014-08-05 1:29 [PATCH] lib: Improve documentation of _notmuch_message_create_for_message_id Austin Clements
@ 2014-08-05 11:21 ` David Bremner
0 siblings, 0 replies; 2+ messages in thread
From: David Bremner @ 2014-08-05 11:21 UTC (permalink / raw)
To: Austin Clements, notmuch
Austin Clements <amdragon@MIT.EDU> writes:
> Clarify the state of the returned message when
> _notmuch_message_create_for_message_id returns
> NOTMUCH_PRIVATE_STATUS_NO_DOCUMENT_FOUND.
pushed,
d
^ permalink raw reply [flat|nested] 2+ messages in thread
end of thread, other threads:[~2014-08-05 11:21 UTC | newest]
Thread overview: 2+ messages (download: mbox.gz / follow: Atom feed)
-- links below jump to the message on this page --
2014-08-05 1:29 [PATCH] lib: Improve documentation of _notmuch_message_create_for_message_id Austin Clements
2014-08-05 11:21 ` David Bremner
Code repositories for project(s) associated with this public inbox
https://yhetil.org/notmuch.git/
This is a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox;
as well as URLs for read-only IMAP folder(s) and NNTP newsgroup(s).