* How is a procedure's signature documented?
@ 2014-04-29 13:22 Diogo F. S. Ramos
0 siblings, 0 replies; only message in thread
From: Diogo F. S. Ramos @ 2014-04-29 13:22 UTC (permalink / raw)
To: guile-user
Is there a pattern they must/should follow?
Using (ice-9 documentation), I've been looking at some procedure
signatures. For what I can tell, they are described in the first line
of `object-documentation'.
Here are some examples:
(object-documentation car)
=> "- Scheme Procedure: car "
(object-documentation cdr)
=> "- Scheme Procedure: cdr "
(object-documentation list)
=> "- Scheme Procedure: list . objs"
(object-documentation array-ref)
=> "- Scheme Procedure: array-ref v [idx0 [idx1 . idxN]]"
`car' and `cdr' don't show a lambda list. `list' shows a dot, which I
assume it's an indication that the following parameter is a rest.
`array-ref' too has a dot, but it also has []s which IIUC represent
optional arguments but are not valid lambda list constituents.
^ permalink raw reply [flat|nested] only message in thread
only message in thread, other threads:[~2014-04-29 13:22 UTC | newest]
Thread overview: (only message) (download: mbox.gz follow: Atom feed
-- links below jump to the message on this page --
2014-04-29 13:22 How is a procedure's signature documented? Diogo F. S. Ramos
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).