Re: [PATCH] python/doc: fix link to notmuch-config manpage

Subject: Re: [PATCH] python/doc: fix link to notmuch-config manpage

Date: Tue, 24 Jun 2025 08:57:05 +0300

To: David Bremner, notmuch@notmuchmail.org

Cc:

From: Tomi Ollila


On Sun, Jun 22 2025, David Bremner wrote:

> This docstring has been like this a long time, but recently I noticed
> sphinx-doc complaining about :man:. This :any: link seems to work, and
> is consistent with the other links to the notmuch-config man page.

diff context doesn't show whether this is context but I trust
(without checking, in this particular case) that it is, so LGTM :D

Tomi

> ---
>  bindings/python-cffi/notmuch2/_database.py | 2 +-
>  1 file changed, 1 insertion(+), 1 deletion(-)
>
> diff --git a/bindings/python-cffi/notmuch2/_database.py b/bindings/python-cffi/notmuch2/_database.py
> index f1451bf1..c13d9fcf 100644
> --- a/bindings/python-cffi/notmuch2/_database.py
> +++ b/bindings/python-cffi/notmuch2/_database.py
> @@ -833,7 +833,7 @@ class IndexOptions(base.NotmuchObject):
>          """The decryption policy.
>  
>          This is an enum from the :class:`DecryptionPolicy`.  See the
> -        `index.decrypt` section in :man:`notmuch-config` for details
> +        `index.decrypt` section in :any:`notmuch-config(1)` for details
>          on the options.  **Do not set this to
>          :attr:`DecryptionPolicy.TRUE`** without considering the
>          security of your index.
> -- 
> 2.47.2
>
> _______________________________________________
> notmuch mailing list -- notmuch@notmuchmail.org
> To unsubscribe send an email to notmuch-leave@notmuchmail.org
_______________________________________________
notmuch mailing list -- notmuch@notmuchmail.org
To unsubscribe send an email to notmuch-leave@notmuchmail.org

Thread: