bug#67138: [PATCH] ; Fix 'add-face-text-property' shortdoc

bug#67138: [PATCH] ; Fix 'add-face-text-property' shortdoc

[Eshel Yaron via Bug reports for GNU Emacs, the Swiss army knife of text editors]

[-- Attachment #1: Type: text/plain, Size: 344 bytes --]

Tags: patch

Hi,

This fixes an omission in shortdoc.el that causes the following to emit
an error instead of showing the *Help* buffer:

1. emacs -Q
2. (add-hook 'help-fns-describe-function-functions
             #'shortdoc-help-fns-examples-function)
3. C-h f add-face-text-property RET
4. Emacs says "Wrong type argument: prop-match, nil"



[-- Warning: decoded text below may be mangled, UTF-8 assumed --]
[-- Attachment #2: 0001-Fix-add-face-text-property-shortdoc.patch --]
[-- Type: text/patch, Size: 977 bytes --]

From 2d79dcd386e0ac5f1b72d3df7d770b7615dae8c8 Mon Sep 17 00:00:00 2001
From: Eshel Yaron <me@eshelyaron.com>
Date: Sun, 12 Nov 2023 21:42:25 +0100
Subject: [PATCH] ; Fix 'add-face-text-property' shortdoc

* lisp/emacs-lisp/shortdoc.el (text-properties): Add missing
':no-eval' keyword.
---
 lisp/emacs-lisp/shortdoc.el | 2 +-
 1 file changed, 1 insertion(+), 1 deletion(-)

diff --git a/lisp/emacs-lisp/shortdoc.el b/lisp/emacs-lisp/shortdoc.el
index dbc061d8a70..1fa798beae1 100644
--- a/lisp/emacs-lisp/shortdoc.el
+++ b/lisp/emacs-lisp/shortdoc.el
@@ -1388,7 +1388,7 @@ text-properties
   (set-text-properties
    :no-eval (set-text-properties (point) (1+ (point)) '(face error)))
   (add-face-text-property
-   (add-face-text-property START END '(:foreground "green")))
+   :no-eval (add-face-text-property START END '(:foreground "green")))
   (propertize
    :eval (propertize "foo" 'face 'italic 'mouse-face 'bold-italic))
   "Searching for Text Properties"
-- 
2.42.0

bug#67138: [PATCH] ; Fix 'add-face-text-property' shortdoc

[Eli Zaretskii]

> Date: Sun, 12 Nov 2023 21:49:24 +0100
> From:  Eshel Yaron via "Bug reports for GNU Emacs,
>  the Swiss army knife of text editors" <bug-gnu-emacs@gnu.org>
> 
> This fixes an omission in shortdoc.el that causes the following to emit
> an error instead of showing the *Help* buffer:
> 
> 1. emacs -Q
> 2. (add-hook 'help-fns-describe-function-functions
>              #'shortdoc-help-fns-examples-function)
> 3. C-h f add-face-text-property RET
> 4. Emacs says "Wrong type argument: prop-match, nil"

It also shows the example if one just does "C-h f" without any hooks.

Thanks, installed on the emacs-29 branch, and closing the bug.