unofficial mirror of notmuch@notmuchmail.org
 help / color / mirror / code / Atom feed
From: David Bremner <david@tethera.net>
To: notmuch@notmuchmail.org
Subject: [PATCH 1/4] python-cffi: fix typos in docstring for Database.default_path
Date: Sat, 30 Oct 2021 13:22:32 -0300	[thread overview]
Message-ID: <20211030162235.1203886-2-david@tethera.net> (raw)
In-Reply-To: <20211030162235.1203886-1-david@tethera.net>

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 | 6 +++---
 1 file 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:
-- 
2.33.0

  reply	other threads:[~2021-10-30 16:23 UTC|newest]

Thread overview: 10+ messages / expand[flat|nested]  mbox.gz  Atom feed  top
2021-10-30 16:22 Use libnotmuch config / database search in python-cffi bindings David Bremner
2021-10-30 16:22 ` David Bremner [this message]
2021-12-04 13:47   ` [PATCH 1/4] python-cffi: fix typos in docstring for Database.default_path David Bremner
2021-10-30 16:22 ` [PATCH 2/4] test: add python-cffi bindings to path for test_python David Bremner
2021-10-30 16:22 ` [PATCH 3/4] test: add known broken tests for python bindings in split configs David Bremner
2021-10-30 16:22 ` [PATCH 4/4] python-cffi: switch to notmuch_database_{open,create}_with_config David Bremner
2021-10-31 19:46   ` Tomi Ollila
     [not found]   ` <87tugu9r4a.fsf@powell.devork.be>
2021-11-03  0:32     ` David Bremner
2021-11-03 21:49       ` Tomi Ollila
2021-11-05 18:17       ` Floris Bruynooghe

Reply instructions:

You may reply publicly to this message via plain-text email
using any one of the following methods:

* Save the following mbox file, import it into your mail client,
  and reply-to-all from there: mbox

  Avoid top-posting and favor interleaved quoting:
  https://en.wikipedia.org/wiki/Posting_style#Interleaved_style

  List information: https://notmuchmail.org/

* Reply using the --to, --cc, and --in-reply-to
  switches of git-send-email(1):

  git send-email \
    --in-reply-to=20211030162235.1203886-2-david@tethera.net \
    --to=david@tethera.net \
    --cc=notmuch@notmuchmail.org \
    /path/to/YOUR_REPLY

  https://kernel.org/pub/software/scm/git/docs/git-send-email.html

* If your mail client supports setting the In-Reply-To header
  via mailto: links, try the mailto: link
Be sure your reply has a Subject: header at the top and a blank line before the message body.
Code repositories for project(s) associated with this public inbox

	https://yhetil.org/notmuch.git/

This is a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox;
as well as URLs for read-only IMAP folder(s) and NNTP newsgroup(s).