suzanne.soy/racket
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

Update generic docs to explain the optional defined-table argument.

Browse Source
This commit is contained in:
Vincent St-Amour 2012-05-09 14:38:38 -04:00 committed by Asumu Takikawa
parent 36980c262f
commit c29a65485e
1 changed files with 13 additions and 2 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

15
collects/generics/scribblings/generics.scrbl
View File

@ -2,11 +2,14 @@
@(require (for-label racket/base generics))
@title{Generics}
@author["Eli Barzilay" @author+email["Jay McCarthy" "jay@racket-lang.org"]]
@author[@author+email["Eli Barzilay" "eli@racket-lang.org"]
@author+email["Jay McCarthy" "jay@racket-lang.org"]
@author+email["Vincent St-Amour" "stamourv@racket-lang.org"]
@author+email["Asumu Takikawa" "asumu@racket-lang.org"]]
@defmodule[generics]
@defform/subs[(define-generics (name prop:name name?)
@defform/subs[(define-generics (name prop:name name? [defined-table])
[method . kw-formals*]
...)
([kw-formals* (arg* ...)
@ -43,6 +46,14 @@ must have a required by-position argument that is
@racket[free-identifier=?] to @racket[name]. This argument is used in
the generic definition to locate the specialization.
The optional @racket[defined-table] argument should be an identifier.
@racket[define-generics] will bind it to a procedure that takes an instance of
the generics and returns an immutable hash-table that maps symbols
corresponding to method names to booleans representing whether or not that
method is implemented by that instance. The intended use case for this table is
to allow higher-level APIs to adapt their behavior depending on method
availability.
}
@defform[(generics name