mirror of
https://git.notmuchmail.org/git/notmuch
synced 2024-11-25 12:28:09 +01:00
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:
parent
a274848f95
commit
6ed606c19e
1 changed files with 3 additions and 0 deletions
|
@ -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,
|
||||
|
|
Loading…
Reference in a new issue