diff options
| author | Austin Ray <austin@austinray.io> | 2021-08-14 18:39:17 -0400 |
|---|---|---|
| committer | David Bremner <david@tethera.net> | 2021-08-17 16:30:05 -0700 |
| commit | 414ba75c81133fb9b6390d79bd40e3d8fb83a269 (patch) | |
| tree | b749546b8c0bffdf73d5657e89c461078e585d3b | |
| parent | af56f3bcdc8a644564a1182f58bd311907193a4a (diff) | |
lib: correct deprecated db open functions' docs
Both notmuch_database_open() and notmuch_database_open_verbose()'s
documentation state they call notmuch_database_open_with_config() with
config_path=NULL; however, their implementations pass an empty string.
The empty string is the correct value to maintain their original
behavior of not loading the user's configuration so their documentation
is incorrect.
| -rw-r--r-- | lib/notmuch.h | 4 |
1 files changed, 2 insertions, 2 deletions
diff --git a/lib/notmuch.h b/lib/notmuch.h index 4b053932..c0fa1768 100644 --- a/lib/notmuch.h +++ b/lib/notmuch.h @@ -316,7 +316,7 @@ typedef enum { /** * Deprecated alias for notmuch_database_open_with_config with - * config_path=error_message=NULL + * config_path="" and error_message=NULL * @deprecated Deprecated as of libnotmuch 5.4 (notmuch 0.32) */ /* NOTMUCH_DEPRECATED(5, 4) */ @@ -326,7 +326,7 @@ notmuch_database_open (const char *path, notmuch_database_t **database); /** * Deprecated alias for notmuch_database_open_with_config with - * config_path=NULL + * config_path="" * * @deprecated Deprecated as of libnotmuch 5.4 (notmuch 0.32) * |