diff options
| author |  Austin Clements <amdragon@MIT.EDU> | 2014-08-04 21:29:16 -0400 |
|---|---|---|
| committer |  David Bremner <david@tethera.net> | 2014-08-05 08:14:15 -0300 |
| commit | 0c1292051eef2a6f6a9a07630eadffe53186489e (patch) | |
| tree | ef63b0a9f72a3e270a4e327ecf1e00c95a0e9fd5 /lib | |
| parent | e501a16e71d79393ffa6bf755a8202e212ab4872 (diff) | |
lib: Improve documentation of _notmuch_message_create_for_message_id
Clarify the state of the returned message when
_notmuch_message_create_for_message_id returns
NOTMUCH_PRIVATE_STATUS_NO_DOCUMENT_FOUND.
Diffstat (limited to 'lib')
| -rw-r--r-- | lib/message.cc | 8 |
1 files changed, 5 insertions, 3 deletions
diff --git a/lib/message.cc b/lib/message.cc index 90a01eb8..3f934265 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 |