lib: Clarify internal documentation of _notmuch_database_filename_to_direntry

The original wording made it sound like this function was just doing
some string manipulation. But this function actually creates new
directory documents as a side effect. So make that explicit in its
documentation.
This commit is contained in:
Carl Worth 2010-01-07 09:31:58 -08:00
parent a274848f95
commit 6ed606c19e

View file

@ -723,6 +723,9 @@ _notmuch_database_get_directory_path (void *ctx,
* database path or absolute with initial components identical to
* database path), return a new string (with 'ctx' as the talloc
* owner) suitable for use as a direntry term value.
*
* The necessary directory documents will be created in the database
* as needed.
*/
notmuch_status_t
_notmuch_database_filename_to_direntry (void *ctx,