aboutsummaryrefslogtreecommitdiff
path: root/doc/ref/object/object.texi
diff options
context:
space:
mode:
Diffstat (limited to 'doc/ref/object/object.texi')
-rw-r--r--doc/ref/object/object.texi11
1 files changed, 11 insertions, 0 deletions
diff --git a/doc/ref/object/object.texi b/doc/ref/object/object.texi
index fd9cb533..fe8afc59 100644
--- a/doc/ref/object/object.texi
+++ b/doc/ref/object/object.texi
@@ -82,6 +82,17 @@ Each type introduces a number of bindings, which are@footnote{
}:
@end deffn
+@deffn {Field Parameter} #:keyword name
+Specify an alternative keyword to use for this parameter when creating
+new instances of the object. Note that @var{name} should be a bare
+symbol, and @emph{not} a keyword object.
+
+@example
+(define-type (my-type)
+ (my-type-x keyword: x))
+@end example
+@end deffn
+
@defun @var{<name>} [kv-args ...]
Type constructor. Takes key-value arguments. Where the keys are the
names of the fields.