mirror/guile
mirror/guile
1
Fork 0
mirror of https://git.savannah.gnu.org/git/guile.git synced 2025-05-20 03:30:27 +02:00
Code Activity

Fix partial commit of documentation update

Browse source 
* doc/ref/api-procedures.texi (Compiled Procedures): Fix
  partially-committed doc update.
This commit is contained in:
Andy Wingo 2013-01-07 23:19:10 +01:00
parent 9f17d967c9
commit 4dbac5e08b
1 changed files with 13 additions and 9 deletions
Download patch file Download diff file Expand all files Collapse all files

22
doc/ref/api-procedures.texi
View file

@ -274,7 +274,9 @@ sense at certain points in the program, delimited by these
Return an association list describing the arguments that @var{program} accepts, or
@code{#f} if the information cannot be obtained.
For example:
The alist keys that are currently defined are `required', `optional',
`keyword', `allow-other-keys?', and `rest'. For example:
@example
(program-arguments-alist
(lambda* (a b #:optional c #:key (d 1) #:rest e)
@ -285,17 +287,19 @@ For example:
(allow-other-keys? . #f)
(rest . d))
@end example
@end deffn
The alist keys that are currently defined are `required', `optional',
`keyword', `allow-other-keys?', and `rest'.
@deffn {Scheme Procedure} program-lambda-list program [ip]
Return a representation of the arguments of @var{program} as a lambda
list, or @code{#f} if this information is not available.
@deffnx {Scheme Procedure} program-lambda-list program [ip]
Accessors for a representation of the arguments of a program, with both
names and types (ie. either required, optional or keywords)
For example:
@code{program-arguments-alist} returns this information in the form of
an association list while @code{program-lambda-list} returns the same
information in a form similar to a lambda definition.
@example
(program-lambda-alist
(lambda* (a b #:optional c #:key (d 1) #:rest e)
#t)) @result{}
@end example
@end deffn
@node Optional Arguments