GNU bug report logs - #12884
24.2.50; defun*: argument lists in documentation look terrible

Previous Next

Full log

View this message in rfc822 format

From: Michael Heerdegen <michael_heerdegen <at> web.de>
To: 12884 <at> debbugs.gnu.org
Subject: bug#12884: 24.2.50; defun*: argument lists in documentation look terrible
Date: Wed, 14 Nov 2012 22:51:09 +0100

Stefan Monnier <monnier <at> 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.

Previous Next

GNU bug tracking system
Copyright (C) 1999 Darren O. Benham, 1997,2003 nCipher Corporation Ltd, 1994-97 Ian Jackson.