diff options
| author | David Bremner <david@tethera.net> | 2021-10-30 13:22:32 -0300 |
|---|---|---|
| committer | David Bremner <david@tethera.net> | 2021-12-04 08:36:07 -0400 |
| commit | 4b361f4d35df92bb2c679143adedf4b88288648c (patch) | |
| tree | a9075fc27547e56363176c60489cc175493ae85e | |
| parent | 59aac9cef37a9937bdf2265078d063673111f80b (diff) | |
python-cffi: fix typos in docstring for Database.default_path
These generate warnings from sphinx doc, which makes it harder to
debug documentation changes. They also corrupt the output.
| -rw-r--r-- | bindings/python-cffi/notmuch2/_database.py | 6 |
1 files changed, 3 insertions, 3 deletions
diff --git a/bindings/python-cffi/notmuch2/_database.py b/bindings/python-cffi/notmuch2/_database.py index 868f4408..c1fb88eb 100644 --- a/bindings/python-cffi/notmuch2/_database.py +++ b/bindings/python-cffi/notmuch2/_database.py @@ -187,8 +187,8 @@ class Database(base.NotmuchObject): :param cfg_path: The pathname of the notmuch configuration file. If not specified tries to use the pathname provided in the - :env:`NOTMUCH_CONFIG` environment variable and falls back - to :file:`~/.notmuch-config. + :envvar:`NOTMUCH_CONFIG` environment variable and falls back + to :file:`~/.notmuch-config`. :type cfg_path: str, bytes, os.PathLike or pathlib.Path. :returns: The path of the database, which does not necessarily @@ -198,7 +198,7 @@ class Database(base.NotmuchObject): be opened. :raises configparser.Error: or subclasses if the configuration file can not be parsed. - :raises NotmuchError if the config file does not have the + :raises NotmuchError: if the config file does not have the database.path setting. """ if not cfg_path: |