From mboxrd@z Thu Jan 1 00:00:00 1970 Return-Path: Received: from mp0 ([2001:41d0:8:6d80::]) (using TLSv1.3 with cipher TLS_AES_256_GCM_SHA384 (256/256 bits)) by ms0.migadu.com with LMTPS id IEyVA2hxfWGDSwEAgWs5BA (envelope-from ) for ; Sat, 30 Oct 2021 18:23:04 +0200 Received: from aspmx1.migadu.com ([2001:41d0:8:6d80::]) (using TLSv1.3 with cipher TLS_AES_256_GCM_SHA384 (256/256 bits)) by mp0 with LMTPS id YCTiOmdxfWEALAAA1q6Kng (envelope-from ) for ; Sat, 30 Oct 2021 16:23:03 +0000 Received: from mail.notmuchmail.org (nmbug.tethera.net [144.217.243.247]) (using TLSv1.3 with cipher TLS_AES_256_GCM_SHA384 (256/256 bits) key-exchange X25519 server-signature RSA-PSS (2048 bits) server-digest SHA256) (No client certificate requested) by aspmx1.migadu.com (Postfix) with ESMTPS id BAA1B1C705 for ; Sat, 30 Oct 2021 18:23:03 +0200 (CEST) Received: from nmbug.tethera.net (localhost [127.0.0.1]) by mail.notmuchmail.org (Postfix) with ESMTP id 0329A1FB27; Sat, 30 Oct 2021 12:22:47 -0400 (EDT) Received: from fethera.tethera.net (fethera.tethera.net [198.245.60.197]) by mail.notmuchmail.org (Postfix) with ESMTP id 8396E1F486 for ; Sat, 30 Oct 2021 12:22:41 -0400 (EDT) Received: by fethera.tethera.net (Postfix, from userid 1001) id 6E4265FC48; Sat, 30 Oct 2021 12:22:41 -0400 (EDT) Received: (nullmailer pid 1204120 invoked by uid 1000); Sat, 30 Oct 2021 16:22:38 -0000 From: David Bremner 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 Message-Id: <20211030162235.1203886-2-david@tethera.net> X-Mailer: git-send-email 2.33.0 In-Reply-To: <20211030162235.1203886-1-david@tethera.net> References: <20211030162235.1203886-1-david@tethera.net> MIME-Version: 1.0 Message-ID-Hash: 3MJCAVYDROIQ34DKXDTCOAVIMSCUHGU5 X-Message-ID-Hash: 3MJCAVYDROIQ34DKXDTCOAVIMSCUHGU5 X-MailFrom: bremner@tethera.net X-Mailman-Rule-Misses: dmarc-mitigation; no-senders; approved; emergency; loop; banned-address; member-moderation; header-match-notmuch.notmuchmail.org-0; nonmember-moderation; administrivia; implicit-dest; max-recipients; max-size; news-moderation; no-subject; digests; suspicious-header X-Mailman-Version: 3.3.3 Precedence: list List-Id: "Use and development of the notmuch mail system." List-Help: List-Owner: List-Post: List-Subscribe: List-Unsubscribe: Content-Type: text/plain; charset="us-ascii" Content-Transfer-Encoding: 7bit X-Migadu-Flow: FLOW_IN ARC-Message-Signature: i=1; a=rsa-sha256; c=relaxed/relaxed; d=yhetil.org; s=key1; t=1635610983; h=from:from:reply-to:subject:subject:date:date:message-id:message-id: to:to:cc:mime-version:mime-version:content-type:content-type: content-transfer-encoding:content-transfer-encoding: in-reply-to:in-reply-to:references:references:list-id:list-help: list-owner:list-unsubscribe:list-subscribe:list-post; bh=wFqb5s74mA4bvYJ5FrGoL1e9MdNk1Yjpt5ZA2TPIbkI=; b=IVQwbsgbo2PUCtJUMxsbr82z+uG/or8rijZPv8gMlAN0/EwyZIXighjhCfdVguvUsaUTNL AGWsGUiTC6j8BEiT861qJ4GKCP6VBOe8NkNgbyR+OSTX0PaPk6GGgLedACHnJpvgoFdb30 I6DV9CoFi4vT9oczNTrTIM+dwNww7/70QiMwM+1cE+hLB79z+YpSKiM1tli36eVw6m1Qat l+qmj7kcs+IwXJ+YweJ8E8Ye/AswhtQjegJVk72m9DhFBlWs8rSfBdgvMH6iAOWsTmzEMO GAkGRYV2MZ+EMQTtooigw18Vdt+KsgQc515pdAxDEa/XmkBb2bf8kinpKRdRAw== ARC-Seal: i=1; s=key1; d=yhetil.org; t=1635610983; a=rsa-sha256; cv=none; b=VRgYdxZ5EwF/NYdeky31AnMgTuBIw9LoCdJ+lepicocH4GKl2Sb+cYvbrmpi0kotBBhqHr KoPBCnqtkMJTJAqfJZm8AD6gURdp07gqwW5XTl4QcDc45S26ISc7Y2EbmvFx8gQb5ZNAJ6 FMzTMIlG9ARiF3I+LaDkrkI7mg2GVcBksffBRB0q84rw/Aqoa4+uN6BruKYHa4uQEXvWbz gYrmfXXeyBE/memHuoeJOWqybPei6scJEBh6fMb7QvKxVvLIOFAqJ5ic/mIFMxNfdta02/ E5+fyVepI7a35UC6AUJ8SMaydVnT/UyfCacI1u9+mlF51fBok/2AsieIDnU/1Q== ARC-Authentication-Results: i=1; aspmx1.migadu.com; dkim=none; dmarc=none; spf=pass (aspmx1.migadu.com: domain of notmuch-bounces@notmuchmail.org designates 144.217.243.247 as permitted sender) smtp.mailfrom=notmuch-bounces@notmuchmail.org X-Migadu-Spam-Score: -1.15 Authentication-Results: aspmx1.migadu.com; dkim=none; dmarc=none; spf=pass (aspmx1.migadu.com: domain of notmuch-bounces@notmuchmail.org designates 144.217.243.247 as permitted sender) smtp.mailfrom=notmuch-bounces@notmuchmail.org X-Migadu-Queue-Id: BAA1B1C705 X-Spam-Score: -1.15 X-Migadu-Scanner: scn0.migadu.com X-TUID: j+JshjrB42YZ 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