Skip to content

Commit

Permalink
doc: expand the documentation for list-view
Browse files Browse the repository at this point in the history
Closes #53
  • Loading branch information
Bogdanp committed Jul 2, 2024
1 parent 670456b commit d683e31
Showing 1 changed file with 8 additions and 4 deletions.
12 changes: 8 additions & 4 deletions gui-easy/gui/easy/scribblings/reference.scrbl
Original file line number Diff line number Diff line change
Expand Up @@ -347,10 +347,14 @@
[#:stretch stretch (maybe-obs/c stretch/c) '(#t #t)]
[#:mixin mix (make-mixin-contract gui:panel%) values]) (is-a?/c view<%>)]{

Returns a representation of a panel that renders the
@racket[entries] by passing each one as a @tech{derived observable}
to @racket[make-view]. Each entry must have a unique
@racket[#:key].
Returns a representation of a panel that renders the @racket[entries]
by passing each one as a @tech{derived observable} to
@racket[make-view]. The @racket[make-view] procedure is called with
the key and the derived observable of each entry. The @racket[#:key]
procedure must return a unique value for each entry in the list, as
compared using @racket[equal?].

See @filepath{examples/list.rkt} for an example.
}

@defproc[(observable-view [data (obs/c any/c)]
Expand Down

0 comments on commit d683e31

Please sign in to comment.