* bug#65270: 30.0.50; `describe-function' issue with some methods
@ 2023-08-13 10:36 David Ponce
2023-08-14 10:41 ` David Ponce
2023-08-15 2:40 ` Stefan Monnier via Bug reports for GNU Emacs, the Swiss army knife of text editors
0 siblings, 2 replies; 6+ messages in thread
From: David Ponce @ 2023-08-13 10:36 UTC (permalink / raw)
To: 65270
Hello,
It seems there is an issue with `describe-function' of a method that
calls `cl-call-next-method'. For a such method `describe-function' says
that the method is "Undocumented" even if a doc string is present.
Also the mentioned signature is weird. See an illustration below using
a simple recipe, running 'emacs -Q'.
Thanks!
<1> In scratch buffer eval:
===========================
*scratch*
------------------------------------------------------------------
(cl-defgeneric foo (arg)
"Generic foo receiving any ARG."
(format "%S" arg))
foo
(cl-defmethod foo ((arg atom))
"Specialized foo receiving any atoms."
(format "atom %s" (cl-call-next-method)))
foo
(cl-defmethod foo ((arg string))
"Specialized foo receiving strings."
(format "string %S" arg))
foo
;; Check results are correct
(foo 1)
"atom 1"
(foo '(1))
"(1)"
(foo "1")
"string \"1\""
------------------------------------------------------------------
<2> M-x describe-function RET foo RET
=====================================
*Help* (is not correct for the method using `cl-call-next-method')
------------------------------------------------------------------
foo is a byte-compiled Lisp function.
(foo ARG)
Generic foo receiving any ARG.
Probably introduced at or before Emacs version 1.2.
This is a generic function.
Implementations:
(foo (ARG string))
Specialized foo receiving strings.
(foo (ARG0 atom) &rest CL--ARGS) <<<<<<<<<<<<< Incorrect
Undocumented
(foo ARG)
Undocumented
------------------------------------------------------------------
<3> In scratch buffer eval:
===========================
*scratch*
------------------------------------------------------------------
;; Redefine method without calling `cl-call-next-method'
(cl-defmethod foo ((arg atom))
"Specialized foo receiving any atoms."
(format "atom %S" arg))
foo
;; Check results are correct
(foo 1)
"atom 1"
(foo '(1))
"(1)"
(foo "1")
"string \"1\""
------------------------------------------------------------------
<4> M-x describe-function RET foo RET
=====================================
*Help* (is correct)
------------------------------------------------------------------
foo is a byte-compiled Lisp function.
(foo ARG)
Generic foo receiving any ARG.
Probably introduced at or before Emacs version 1.2.
This is a generic function.
Implementations:
(foo (ARG string))
Specialized foo receiving strings.
(foo (ARG atom)) <<<<<<<<<<<<< Correct
Specialized foo receiving any atoms.
(foo ARG)
Undocumented
------------------------------------------------------------------
In GNU Emacs 30.0.50 (build 1, x86_64-pc-linux-gnu, GTK+ Version
3.24.38, cairo version 1.17.8) of 2023-08-13
Repository revision: de6c1c4d5c92b92d5b280e157c2a5bc3228749f2
Repository branch: master
Windowing system distributor 'The X.Org Foundation', version 11.0.12014000
System Description: Fedora Linux 38 (KDE Plasma)
Configured using:
'configure --with-x-toolkit=gtk3
--with-native-compilation=no'
Configured features:
ACL CAIRO DBUS FREETYPE GIF GLIB GMP GNUTLS GSETTINGS HARFBUZZ JPEG JSON
LCMS2 LIBOTF LIBSELINUX LIBSYSTEMD LIBXML2 M17N_FLT MODULES NOTIFY
INOTIFY PDUMPER PNG RSVG SECCOMP SOUND SQLITE3 THREADS TIFF
TOOLKIT_SCROLL_BARS TREE_SITTER WEBP X11 XDBE XIM XINPUT2 XPM GTK3 ZLIB
Important settings:
value of $LC_TIME: fr_FR.utf8
value of $LANG: fr_FR.UTF-8
locale-coding-system: utf-8-unix
^ permalink raw reply [flat|nested] 6+ messages in thread
* bug#65270: 30.0.50; `describe-function' issue with some methods
2023-08-13 10:36 bug#65270: 30.0.50; `describe-function' issue with some methods David Ponce
@ 2023-08-14 10:41 ` David Ponce
2023-08-14 22:04 ` David Ponce
2023-08-15 2:40 ` Stefan Monnier via Bug reports for GNU Emacs, the Swiss army knife of text editors
1 sibling, 1 reply; 6+ messages in thread
From: David Ponce @ 2023-08-14 10:41 UTC (permalink / raw)
To: 65270; +Cc: Stefan Monnier
[-- Attachment #1: Type: text/plain, Size: 722 bytes --]
On 13/08/2023 12:36, David Ponce wrote:
> Hello,
>
> It seems there is an issue with `describe-function' of a method that
> calls `cl-call-next-method'. For a such method `describe-function' says
> that the method is "Undocumented" even if a doc string is present.
>
> Also the mentioned signature is weird. See an illustration below using
> a simple recipe, running 'emacs -Q'.
>
[...]
Hello,
The attached patch fixed for me the doc string issue with `describe-function'
for methods calling `cl-call-next-method'.
It would be nice if someone who better knows the cl-generic library will
double check it (CC Stefan, the author).
Unfortunately, I didn't find a solution for arguments.
Hope it will help.
Thanks
[-- Attachment #2: cl-generic-docstring-1.patch --]
[-- Type: text/x-patch, Size: 2189 bytes --]
diff --git a/lisp/emacs-lisp/cl-generic.el b/lisp/emacs-lisp/cl-generic.el
index b062c280a41..722211d6ba8 100644
--- a/lisp/emacs-lisp/cl-generic.el
+++ b/lisp/emacs-lisp/cl-generic.el
@@ -429,6 +429,15 @@ cl-generic-define-context-rewriter
(lexical-binding
(cons 'curried
`#'(lambda (,nm) ;Called when constructing the effective method.
+ ,@(let* ((prebody (car parsed-body))
+ (ds (if (stringp (car prebody))
+ prebody
+ (setq prebody (cons nil prebody))))
+ (usage (help-split-fundoc (car ds) nil)))
+ (unless usage
+ (setcar ds (help-add-fundoc-usage (car ds)
+ args)))
+ prebody)
(let ((,nmp (if (cl--generic-isnot-nnm-p ,nm)
#'always #'ignore)))
;; This `(λ (&rest x) .. (apply (λ (args) ..) x))'
@@ -446,15 +455,6 @@ cl-generic-define-context-rewriter
;; is always called directly and there are no
;; `&optional' args.
(lambda (&rest ,arglist)
- ,@(let* ((prebody (car parsed-body))
- (ds (if (stringp (car prebody))
- prebody
- (setq prebody (cons nil prebody))))
- (usage (help-split-fundoc (car ds) nil)))
- (unless usage
- (setcar ds (help-add-fundoc-usage (car ds)
- args)))
- prebody)
(let ((,cnm (lambda (&rest args)
(apply ,nm (or args ,arglist)))))
;; This `apply+lambda' basically parses
^ permalink raw reply related [flat|nested] 6+ messages in thread* bug#65270: 30.0.50; `describe-function' issue with some methods
2023-08-14 10:41 ` David Ponce
@ 2023-08-14 22:04 ` David Ponce
0 siblings, 0 replies; 6+ messages in thread
From: David Ponce @ 2023-08-14 22:04 UTC (permalink / raw)
To: 65270; +Cc: Stefan Monnier
On 14/08/2023 12:41, David Ponce wrote:
> On 13/08/2023 12:36, David Ponce wrote:
>> Hello,
>>
>> It seems there is an issue with `describe-function' of a method that
>> calls `cl-call-next-method'. For a such method `describe-function' says
>> that the method is "Undocumented" even if a doc string is present.
>>
>> Also the mentioned signature is weird. See an illustration below using
>> a simple recipe, running 'emacs -Q'.
>>
> [...]
>
> Hello,
>
> The attached patch fixed for me the doc string issue with `describe-function'
> for methods calling `cl-call-next-method'.
>
> It would be nice if someone who better knows the cl-generic library will
> double check it (CC Stefan, the author).
>
> Unfortunately, I didn't find a solution for arguments.
>
> Hope it will help.
>
> Thanks
Please forget my previous patch, it doesn't fix the issue in all cases.
Hopefully someone will find the proper fix.
Thanks
^ permalink raw reply [flat|nested] 6+ messages in thread
* bug#65270: 30.0.50; `describe-function' issue with some methods
2023-08-13 10:36 bug#65270: 30.0.50; `describe-function' issue with some methods David Ponce
2023-08-14 10:41 ` David Ponce
@ 2023-08-15 2:40 ` Stefan Monnier via Bug reports for GNU Emacs, the Swiss army knife of text editors
2023-08-15 9:09 ` David Ponce
1 sibling, 1 reply; 6+ messages in thread
From: Stefan Monnier via Bug reports for GNU Emacs, the Swiss army knife of text editors @ 2023-08-15 2:40 UTC (permalink / raw)
To: David Ponce; +Cc: 65270
> It seems there is an issue with `describe-function' of a method that
> calls `cl-call-next-method'. For a such method `describe-function' says
> that the method is "Undocumented" even if a doc string is present.
I pushed a patch to `master` which seems to fix this problem.
> Also the mentioned signature is weird. See an illustration below using
> a simple recipe, running 'emacs -Q'.
I think we still have a problem here when the method is not
byte-compiled, but I think the problem is in `help-function-arglist`
which decides to use the "raw arglist" from the interpreted closure
without looking at the arg names stashed in the docstring.
Stefan
^ permalink raw reply [flat|nested] 6+ messages in thread* bug#65270: 30.0.50; `describe-function' issue with some methods
2023-08-15 2:40 ` Stefan Monnier via Bug reports for GNU Emacs, the Swiss army knife of text editors
@ 2023-08-15 9:09 ` David Ponce
2023-09-15 12:24 ` Stefan Kangas
0 siblings, 1 reply; 6+ messages in thread
From: David Ponce @ 2023-08-15 9:09 UTC (permalink / raw)
To: Stefan Monnier; +Cc: 65270
On 15/08/2023 04:40, Stefan Monnier wrote:
>> It seems there is an issue with `describe-function' of a method that
>> calls `cl-call-next-method'. For a such method `describe-function' says
>> that the method is "Undocumented" even if a doc string is present.
>
> I pushed a patch to `master` which seems to fix this problem.
>
>> Also the mentioned signature is weird. See an illustration below using
>> a simple recipe, running 'emacs -Q'.
>
> I think we still have a problem here when the method is not
> byte-compiled, but I think the problem is in `help-function-arglist`
> which decides to use the "raw arglist" from the interpreted closure
> without looking at the arg names stashed in the docstring.
>
>
> Stefan
>
Hello Stefan,
I confirm that your patch fixed the issue with doc string, and with
arglist of byte-compiled methods (which is probably the common case).
Thank you very much!
^ permalink raw reply [flat|nested] 6+ messages in thread
* bug#65270: 30.0.50; `describe-function' issue with some methods
2023-08-15 9:09 ` David Ponce
@ 2023-09-15 12:24 ` Stefan Kangas
0 siblings, 0 replies; 6+ messages in thread
From: Stefan Kangas @ 2023-09-15 12:24 UTC (permalink / raw)
To: David Ponce; +Cc: 65270-done, Stefan Monnier
Version: 30.1
David Ponce <da_vid@orange.fr> writes:
> On 15/08/2023 04:40, Stefan Monnier wrote:
>>> It seems there is an issue with `describe-function' of a method that
>>> calls `cl-call-next-method'. For a such method `describe-function' says
>>> that the method is "Undocumented" even if a doc string is present.
>> I pushed a patch to `master` which seems to fix this problem.
>>
>>> Also the mentioned signature is weird. See an illustration below using
>>> a simple recipe, running 'emacs -Q'.
>> I think we still have a problem here when the method is not
>> byte-compiled, but I think the problem is in `help-function-arglist`
>> which decides to use the "raw arglist" from the interpreted closure
>> without looking at the arg names stashed in the docstring.
>> Stefan
>>
>
> Hello Stefan,
>
> I confirm that your patch fixed the issue with doc string, and with
> arglist of byte-compiled methods (which is probably the common case).
>
> Thank you very much!
It seems like this issue was fixed, but it was left open in the bug
tracker. I'm therefore closing it now.
^ permalink raw reply [flat|nested] 6+ messages in thread
end of thread, other threads:[~2023-09-15 12:24 UTC | newest]
Thread overview: 6+ messages (download: mbox.gz follow: Atom feed
-- links below jump to the message on this page --
2023-08-13 10:36 bug#65270: 30.0.50; `describe-function' issue with some methods David Ponce
2023-08-14 10:41 ` David Ponce
2023-08-14 22:04 ` David Ponce
2023-08-15 2:40 ` Stefan Monnier via Bug reports for GNU Emacs, the Swiss army knife of text editors
2023-08-15 9:09 ` David Ponce
2023-09-15 12:24 ` Stefan Kangas
Code repositories for project(s) associated with this public inbox
https://git.savannah.gnu.org/cgit/emacs.git
This is a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox;
as well as URLs for read-only IMAP folder(s) and NNTP newsgroup(s).