---
 arei-ui.el | 6 +++++-
 1 file changed, 5 insertions(+), 1 deletion(-)

diff --git a/arei-ui.el b/arei-ui.el
index 6ec448b..de5ba89 100644
--- a/arei-ui.el
+++ b/arei-ui.el
@@ -89,7 +89,11 @@ A bit of a hack, but works fine."
             'arei-ui--eros--remove-result-overlay)
 
 (defun arei-ui-show-result (fmt result &optional expression-end)
-  "Show result with overlay if possible or message, when it's not."
+  "Show RESULT with overlay if possible or message, when it's not.
+FMT is a format string that determines how RESULT will be displayed.
+EXPRESSION-END may be a number or marker, applying the overlay to the
+whole line at that position (defaulting to `point').  If it’s a cons
+cell, its car and cdr specify the overlay’s start and end."
   (when arei-ui-show-result-p
     (let ((forward-sexp-function
            (lambda (&rest args)

base-commit: d7b67dd98fb66196e8413840ccd8fd736807ed72
-- 
2.46.0


-- 
Best regards,
Aleksandr Vityazev

emacs-arei/patches/.build.yml: SUCCESS in 38s

[Enhance arei-ui-show-result doc string.][0] from [Aleksandr Vityazev][1]

[0]: https://lists.sr.ht/~abcdw/rde-devel/patches/55628
[1]: avityazev@disroot.org

✓ #1356559 SUCCESS emacs-arei/patches/.build.yml https://builds.sr.ht/~abcdw/job/1356559

On 2024-10-25 23:10, Aleksandr Vityazev wrote:

> ---
>  arei-ui.el | 6 +++++-
>  1 file changed, 5 insertions(+), 1 deletion(-)
>
> diff --git a/arei-ui.el b/arei-ui.el
> index 6ec448b..de5ba89 100644
> --- a/arei-ui.el
> +++ b/arei-ui.el
> @@ -89,7 +89,11 @@ A bit of a hack, but works fine."
>              'arei-ui--eros--remove-result-overlay)
>  
>  (defun arei-ui-show-result (fmt result &optional expression-end)
> -  "Show result with overlay if possible or message, when it's not."
> +  "Show RESULT with overlay if possible or message, when it's not.
> +FMT is a format string that determines how RESULT will be displayed.
> +EXPRESSION-END may be a number or marker, applying the overlay to the
> +whole line at that position (defaulting to `point').  If it’s a cons
> +cell, its car and cdr specify the overlay’s start and end."
>    (when arei-ui-show-result-p
>      (let ((forward-sexp-function
>             (lambda (&rest args)
>
> base-commit: d7b67dd98fb66196e8413840ccd8fd736807ed72
> -- 
> 2.46.0

Looks good, feel free to push it and to close the thread as APPLIED.

-- 
Best regards,
Andrew Tropin