unofficial mirror of bug-gnu-emacs@gnu.org 
 help / color / mirror / code / Atom feed
* bug#12884: 24.2.50; defun*: argument lists in documentation look terrible
@ 2012-11-14 16:47 Michael Heerdegen
  2012-11-14 19:49 ` Stefan Monnier
  0 siblings, 1 reply; 4+ messages in thread
From: Michael Heerdegen @ 2012-11-14 16:47 UTC (permalink / raw)
  To: 12884

If I e.g. define something like that:

(defun* my-toggle-item (mode-or-var
                               &key
                               ((:selected enabled-spec) `(am-bound-and-true-p ',mode-or-var))
                               ((:help     help-string)   (am-make-symbol-docstring mode-or-var)))
  "Toggle item creater for modes and flags."
  ...)

the docstring then looks like that for me:

| my-toggle-item is a Lisp function.
| 
| (my-toggle-item #:MODE-OR-VAR &key ((:selected #:ENABLED-SPEC) (\`
| (am-bound-and-true-p (quote (\, mode-or-var))))) ((:help
| #:HELP-STRING) (am-make-symbol-docstring mode-or-var)))
| 
| Toggle item creater for modes and flags.

This looks terrible with all this #: and quote \, stuff.

The culprit is `cl--transform-lambda', which just uses this:

(format "%S"
        (cons 'fn
              (cl--make-usage-args orig-args)))

I think we can easily improve this, e.g. by using something like

(let (print-gensym print-level print-length (print-quoted t))
  (format "%S"
     (cons 'fn (cl--make-usage-args orig-args))))

instead.  Looks much better in *Help* and with eldoc.


Thanks,

Michael.




In GNU Emacs 24.2.50.1 (x86_64-unknown-linux-gnu, GTK+ Version 2.24.10)
 of 2012-11-13 on drachen
Bzr revision: rgm@gnu.org-20121113081658-e63viomclbw6bjee
Windowing system distributor `The X.Org Foundation', version 11.0.10707000
System Description:	Debian GNU/Linux testing (wheezy)

Configured using:
 `configure '--prefix=/usr/local/built/''






^ permalink raw reply	[flat|nested] 4+ messages in thread

* bug#12884: 24.2.50; defun*: argument lists in documentation look terrible
  2012-11-14 16:47 bug#12884: 24.2.50; defun*: argument lists in documentation look terrible Michael Heerdegen
@ 2012-11-14 19:49 ` Stefan Monnier
  2012-11-14 21:51   ` Michael Heerdegen
  0 siblings, 1 reply; 4+ messages in thread
From: Stefan Monnier @ 2012-11-14 19:49 UTC (permalink / raw)
  To: Michael Heerdegen; +Cc: 12884

> | (my-toggle-item #:MODE-OR-VAR &key ((:selected #:ENABLED-SPEC) (\`
> | (am-bound-and-true-p (quote (\, mode-or-var))))) ((:help
> | #:HELP-STRING) (am-make-symbol-docstring mode-or-var)))

Let me just say that I will resist the urge to tell you what I think
about this style of argument list ;-)

> This looks terrible with all this #: and quote \, stuff.

Binding print-quoted makes sense to improve the quote/backquote syntax.
But I don't understand why we have those #: in there.  I understand it's
there to say the symbols are not interned, but I don't understand why
they're not interned.


        Stefan





^ permalink raw reply	[flat|nested] 4+ messages in thread

* bug#12884: 24.2.50; defun*: argument lists in documentation look terrible
  2012-11-14 19:49 ` Stefan Monnier
@ 2012-11-14 21:51   ` Michael Heerdegen
  2012-11-15  1:28     ` Stefan Monnier
  0 siblings, 1 reply; 4+ messages in thread
From: Michael Heerdegen @ 2012-11-14 21:51 UTC (permalink / raw)
  To: 12884

Stefan Monnier <monnier@iro.umontreal.ca> writes:

> > | (my-toggle-item #:MODE-OR-VAR &key ((:selected #:ENABLED-SPEC) (\`
> > | (am-bound-and-true-p (quote (\, mode-or-var))))) ((:help
> > | #:HELP-STRING) (am-make-symbol-docstring mode-or-var)))
>
> Let me just say that I will resist the urge to tell you what I think
> about this style of argument list ;-)

Please don't resist.  What's wrong with it?

> > This looks terrible with all this #: and quote \, stuff.
>
> Binding print-quoted makes sense to improve the quote/backquote syntax.
> But I don't understand why we have those #: in there.  I understand it's
> there to say the symbols are not interned, but I don't understand why
> they're not interned.

See `cl--make-usage-args'.  It upcases the names of the arguments and
makes them a symbol again.  The one who wrote that wanted that no new
symbols are interned, and so used `make-symbol'.  Dunno if there's a
reason to do so.


- Michael.





^ permalink raw reply	[flat|nested] 4+ messages in thread

* bug#12884: 24.2.50; defun*: argument lists in documentation look terrible
  2012-11-14 21:51   ` Michael Heerdegen
@ 2012-11-15  1:28     ` Stefan Monnier
  0 siblings, 0 replies; 4+ messages in thread
From: Stefan Monnier @ 2012-11-15  1:28 UTC (permalink / raw)
  To: Michael Heerdegen; +Cc: 12884-done

>> > This looks terrible with all this #: and quote \, stuff.
>> Binding print-quoted makes sense to improve the quote/backquote syntax.
>> But I don't understand why we have those #: in there.  I understand it's
>> there to say the symbols are not interned, but I don't understand why
>> they're not interned.
> See `cl--make-usage-args'.  It upcases the names of the arguments and
> makes them a symbol again.  The one who wrote that wanted that no new
> symbols are interned, and so used `make-symbol'.  Dunno if there's a
> reason to do so.

Ah, yes of course.
I installed a patch similar to yours, except I didn't touch print-length
and print-level, since I can't think of a good reason to favor nil
for them.


        Stefan





^ permalink raw reply	[flat|nested] 4+ messages in thread

end of thread, other threads:[~2012-11-15  1:28 UTC | newest]

Thread overview: 4+ messages (download: mbox.gz follow: Atom feed
-- links below jump to the message on this page --
2012-11-14 16:47 bug#12884: 24.2.50; defun*: argument lists in documentation look terrible Michael Heerdegen
2012-11-14 19:49 ` Stefan Monnier
2012-11-14 21:51   ` Michael Heerdegen
2012-11-15  1:28     ` Stefan Monnier

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).