Begin documentation

This commit is contained in:
JackFirth 2015-02-22 19:56:36 -08:00
parent 9d6716c8fe
commit a5fbd7683d

View File

@ -4,15 +4,20 @@
(for-label lenses
racket/base))
@title{Lenses}
@(define lenses-eval (make-base-eval))
@(lenses-eval '(require "main.rkt"))
@(define-syntax-rule (lenses-examples datum ...)
(examples #:eval lenses-eval datum ...))
@title{Lenses}
@defmodule[lenses]
This library includes functions and forms for working with @italic{lenses}.
A lens is a pure function that operates on some small piece of a larger
structure. Think of them as a more general representation of getters and
setters in object-oriented languages.
@author[@author+email["Jack Firth" "jackhfirth@gmail.com"]]
source code: @url["https://github.com/jackfirth/lenses"]
source code: @url["https://github.com/jackfirth/lenses"]