[BUG] Bad quote in help

[BUG] Bad quote in help

[Rudolf Adamkovič]

Repro steps:

1. C-h v
2. notmuch-search-result-format
3. RET

See:

For example:
    (setq notmuch-search-result-format
          ’(("authors" . "%-40s")
            ("subject" . "%s")))

The quote ’ needs changed to ', otherwise the example does not work.

Rudy
-- 
"Thinking is a momentary dismissal of irrelevancies."
-- Richard Buckminster Fuller, 1969

Rudolf Adamkovič <salutis@me.com> [he/him]
Studenohorská 25
84103 Bratislava
Slovakia\r

Re: [BUG] Bad quote in help

[Tomi Ollila]

On Wed, Feb 16 2022, Rudolf Adamkovič wrote:

> Repro steps:
>
> 1. C-h v
> 2. notmuch-search-result-format
> 3. RET
>
> See:
>
> For example:
>     (setq notmuch-search-result-format
>           ’(("authors" . "%-40s")
>             ("subject" . "%s")))
>
> The quote ’ needs changed to ', otherwise the example does not work.

The code in question in notmuch.el is:

    (setq notmuch-search-result-format
          '((\"authors\" . \"%-40s\")
            (\"subject\" . \"%s\")))

In this particular case it is unfortunate emacs modifies the output.

Tried to chage that to  \'((\"autho...

did not help (also renamed the defcustom to make a new definition so
that the content would be evaluated when doing c-x c-e in buffer...)

In rstdoc.el we have (text-quoting-style 'grave) to not do such docstring
modifications for display, but that is not applicable in this context...

Tomi

>
> Rudy
> -- 
> "Thinking is a momentary dismissal of irrelevancies."
> -- Richard Buckminster Fuller, 1969
>
> Rudolf Adamkovič <salutis@me.com> [he/him]
> Studenohorská 25
> 84103 Bratislava
> Slovakia\r

[PATCH] emacs: escape quote in notmuch-search-result-format docstring

[David Bremner]

Prevent Emacs' mangling of quotes, which breaks the code sample.
---
 emacs/notmuch.el | 2 +-
 1 file changed, 1 insertion(+), 1 deletion(-)

diff --git a/emacs/notmuch.el b/emacs/notmuch.el
index 6abb17ff..c9cf80dc 100644
--- a/emacs/notmuch.el
+++ b/emacs/notmuch.el
@@ -93,7 +93,7 @@
 Supported fields are: date, count, authors, subject, tags.
 For example:
     (setq notmuch-search-result-format
-          '((\"authors\" . \"%-40s\")
+          \\='((\"authors\" . \"%-40s\")
             (\"subject\" . \"%s\")))
 
 Line breaks are permitted in format strings (though this is
-- 
2.34.1

Re: [PATCH] emacs: escape quote in notmuch-search-result-format docstring

[Tomi Ollila]

On Wed, Feb 16 2022, David Bremner wrote:

LGTM, now I remeber this syntax...

Tomi

> Prevent Emacs' mangling of quotes, which breaks the code sample.
> ---
>  emacs/notmuch.el | 2 +-
>  1 file changed, 1 insertion(+), 1 deletion(-)
>
> diff --git a/emacs/notmuch.el b/emacs/notmuch.el
> index 6abb17ff..c9cf80dc 100644
> --- a/emacs/notmuch.el
> +++ b/emacs/notmuch.el
> @@ -93,7 +93,7 @@
>  Supported fields are: date, count, authors, subject, tags.
>  For example:
>      (setq notmuch-search-result-format
> -          '((\"authors\" . \"%-40s\")
> +          \\='((\"authors\" . \"%-40s\")
>              (\"subject\" . \"%s\")))
>  
>  Line breaks are permitted in format strings (though this is
> -- 
> 2.34.1

Re: [PATCH] emacs: escape quote in notmuch-search-result-format docstring

[David Bremner]

Tomi Ollila <tomi.ollila@iki.fi> writes:

> On Wed, Feb 16 2022, David Bremner wrote:
>
> LGTM, now I remeber this syntax...
>
> Tomi
>

OK, the docstring is fixed in commit 6286b76a, which should be in the
next major release (0.36).

Thanks for the report,

d