]> git.notmuchmail.org Git - notmuch/commitdiff
python-cffi: fix typos in docstring for Database.default_path
authorDavid Bremner <david@tethera.net>
Sat, 30 Oct 2021 16:22:32 +0000 (13:22 -0300)
committerDavid Bremner <david@tethera.net>
Sat, 4 Dec 2021 12:36:07 +0000 (08:36 -0400)
These generate warnings from sphinx doc, which makes it harder to
debug documentation changes. They also corrupt the output.

bindings/python-cffi/notmuch2/_database.py

index 868f4408cb18f2b00196d6314e1d4f3fe34ade5d..c1fb88eb35c2e956fb7356559bc3041d8772a524 100644 (file)
@@ -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: