* bug#10724: 24.0.93; doc of `typecase'
@ 2012-02-04 18:00 Drew Adams
2012-09-17 0:16 ` Drew Adams
2014-02-09 5:14 ` Lars Ingebrigtsen
0 siblings, 2 replies; 3+ messages in thread
From: Drew Adams @ 2012-02-04 18:00 UTC (permalink / raw)
To: 10724
The doc string does not meet Emacs standards. The arguments are not
described.
Nothing is said about what EXPR, TYPE or BODY can be. BODY is
excusable; the others are not.
We must state that EXPR is any Emacs-Lisp sexp (if that is the case).
And we must state that TYPE is an emacs-lisp type name, as a symbol (if
that is the case). But that's not sufficient, since there is not just a
single list of such type names.
There are at least the following that a reader might understand for
TYPE when reading this doc:
1. the simple-type names for Customize
2. type predicates
3. programming types ((elisp) Programming Types)
4. editing types ((elisp) Editing Types)
For the last two (#3 and #4), which are probably what is meant here,
what symbols (is TYPE a symbol?) are recognized for those types by
`typecase'?
You cannot program using `typecase' without knowing this stuff. And
though Emacs Lisp's `typecase' presumably corresponds somewhat to Common
Lisp's, it is not at all obvious just what values of TYPE are supported
by Emacs Lisp.
In GNU Emacs 24.0.93.1 (i386-mingw-nt5.1.2600)
of 2012-01-29 on MARVIN
Windowing system distributor `Microsoft Corp.', version 5.1.2600
Configured using:
`configure --with-gcc (4.6) --no-opt --cflags
-ID:/devel/emacs/libs/libXpm-3.5.8/include
-ID:/devel/emacs/libs/libXpm-3.5.8/src
-ID:/devel/emacs/libs/libpng-dev_1.4.3-1/include
-ID:/devel/emacs/libs/zlib-dev_1.2.5-2/include
-ID:/devel/emacs/libs/giflib-4.1.4-1/include
-ID:/devel/emacs/libs/jpeg-6b-4/include
-ID:/devel/emacs/libs/tiff-3.8.2-1/include
-ID:/devel/emacs/libs/gnutls-3.0.9/include --ldflags
-LD:/devel/emacs/libs/gnutls-3.0.9/lib'
^ permalink raw reply [flat|nested] 3+ messages in thread
* bug#10724: 24.0.93; doc of `typecase'
2012-02-04 18:00 bug#10724: 24.0.93; doc of `typecase' Drew Adams
@ 2012-09-17 0:16 ` Drew Adams
2014-02-09 5:14 ` Lars Ingebrigtsen
1 sibling, 0 replies; 3+ messages in thread
From: Drew Adams @ 2012-09-17 0:16 UTC (permalink / raw)
To: 10724
ping
^ permalink raw reply [flat|nested] 3+ messages in thread
* bug#10724: 24.0.93; doc of `typecase'
2012-02-04 18:00 bug#10724: 24.0.93; doc of `typecase' Drew Adams
2012-09-17 0:16 ` Drew Adams
@ 2014-02-09 5:14 ` Lars Ingebrigtsen
1 sibling, 0 replies; 3+ messages in thread
From: Lars Ingebrigtsen @ 2014-02-09 5:14 UTC (permalink / raw)
To: Drew Adams; +Cc: 10724
"Drew Adams" <drew.adams@oracle.com> writes:
> The doc string does not meet Emacs standards. The arguments are not
> described.
>
> Nothing is said about what EXPR, TYPE or BODY can be. BODY is
> excusable; the others are not.
This seems to be another report about not putting the entirety of the
Common Lisp standard into the doc strings of the cl-* functions.
Closing.
--
(domestic pets only, the antidote for overdose, milk.)
bloggy blog http://lars.ingebrigtsen.no/
^ permalink raw reply [flat|nested] 3+ messages in thread
end of thread, other threads:[~2014-02-09 5:14 UTC | newest]
Thread overview: 3+ messages (download: mbox.gz follow: Atom feed
-- links below jump to the message on this page --
2012-02-04 18:00 bug#10724: 24.0.93; doc of `typecase' Drew Adams
2012-09-17 0:16 ` Drew Adams
2014-02-09 5:14 ` Lars Ingebrigtsen
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).