[PATCH] doc/sexp-queries: escape @ in non-verbatim text

[PATCH] doc/sexp-queries: escape @ in non-verbatim text

[David Bremner]

This prevents sphinx-doc from creating spurious mailto: links. Thanks
to Jakub Wilk for telling me about the fix.
---
 doc/man7/notmuch-sexp-queries.rst | 12 ++++++------
 1 file changed, 6 insertions(+), 6 deletions(-)

diff --git a/doc/man7/notmuch-sexp-queries.rst b/doc/man7/notmuch-sexp-queries.rst
index bc8e5086..0eb86734 100644
--- a/doc/man7/notmuch-sexp-queries.rst
+++ b/doc/man7/notmuch-sexp-queries.rst
@@ -230,11 +230,11 @@ EXAMPLES
 
 ``(folder (of (id 1234@invalid)))``
 
-    Match any message in the same folder as the one with Message-Id "1234@invalid"
+    Match any message in the same folder as the one with Message-Id "1234\@invalid"
 
 ``(id 1234@invalid blah@test)``
 
-    Matches Message-Id "1234@invalid" *or* Message-Id "blah@test"
+    Matches Message-Id "1234\@invalid" *or* Message-Id "blah\@test"
 
 ``(and (infix "date:2009-11-18..2009-11-18") (tag unread))``
 
@@ -260,18 +260,18 @@ EXAMPLES
 
 ``(thread (of (id 1234@invalid)))``
 
-    Match any message in the same thread as the one with Message-Id "1234@invalid"
+    Match any message in the same thread as the one with Message-Id "1234\@invalid"
 
 ``(thread (matching (from bob@example.com) (to bob@example.com)))``
 
     Match any (messages in) a thread containing a message from
-    "bob@example.com" and a (possibly distinct) message to "bob at
+    "bob\@example.com" and a (possibly distinct) message to "bob at
     example.com")
 
 ``(to (or bob@example.com mallory@example.org))`` ``(or (to bob@example.com) (to mallory@example.org))``
 
-    Match in the "To" or "Cc" headers, "bob@example.com",
-    "mallory@example.org", and also "bob@example.com.au" since it
+    Match in the "To" or "Cc" headers, "bob\@example.com",
+    "mallory\@example.org", and also "bob\@example.com.au" since it
     contains the adjacent triple "bob", "example", "com".
 
 ``(not (to *))``
-- 
2.35.2

Re: [PATCH] doc/sexp-queries: escape @ in non-verbatim text

[Tomi Ollila]

On Thu, Apr 28 2022, David Bremner wrote:

> This prevents sphinx-doc from creating spurious mailto: links. Thanks
> to Jakub Wilk for telling me about the fix.

looks trivial to me
> ---
>  doc/man7/notmuch-sexp-queries.rst | 12 ++++++------
>  1 file changed, 6 insertions(+), 6 deletions(-)
>
> diff --git a/doc/man7/notmuch-sexp-queries.rst b/doc/man7/notmuch-sexp-queries.rst
> index bc8e5086..0eb86734 100644
> --- a/doc/man7/notmuch-sexp-queries.rst
> +++ b/doc/man7/notmuch-sexp-queries.rst
> @@ -230,11 +230,11 @@ EXAMPLES
>  
>  ``(folder (of (id 1234@invalid)))``
>  
> -    Match any message in the same folder as the one with Message-Id "1234@invalid"
> +    Match any message in the same folder as the one with Message-Id "1234\@invalid"
>  
>  ``(id 1234@invalid blah@test)``
>  
> -    Matches Message-Id "1234@invalid" *or* Message-Id "blah@test"
> +    Matches Message-Id "1234\@invalid" *or* Message-Id "blah\@test"
>  
>  ``(and (infix "date:2009-11-18..2009-11-18") (tag unread))``
>  
> @@ -260,18 +260,18 @@ EXAMPLES
>  
>  ``(thread (of (id 1234@invalid)))``
>  
> -    Match any message in the same thread as the one with Message-Id "1234@invalid"
> +    Match any message in the same thread as the one with Message-Id "1234\@invalid"
>  
>  ``(thread (matching (from bob@example.com) (to bob@example.com)))``
>  
>      Match any (messages in) a thread containing a message from
> -    "bob@example.com" and a (possibly distinct) message to "bob at
> +    "bob\@example.com" and a (possibly distinct) message to "bob at
>      example.com")
>  
>  ``(to (or bob@example.com mallory@example.org))`` ``(or (to bob@example.com) (to mallory@example.org))``
>  
> -    Match in the "To" or "Cc" headers, "bob@example.com",
> -    "mallory@example.org", and also "bob@example.com.au" since it
> +    Match in the "To" or "Cc" headers, "bob\@example.com",
> +    "mallory\@example.org", and also "bob\@example.com.au" since it
>      contains the adjacent triple "bob", "example", "com".
>  
>  ``(not (to *))``
> -- 
> 2.35.2
>
> _______________________________________________
> notmuch mailing list -- notmuch@notmuchmail.org
> To unsubscribe send an email to notmuch-leave@notmuchmail.org

Re: [PATCH] doc/sexp-queries: escape @ in non-verbatim text

[David Bremner]

David Bremner <david@tethera.net> writes:

> This prevents sphinx-doc from creating spurious mailto: links. Thanks
> to Jakub Wilk for telling me about the fix.

applied to master.

d