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

document lens/common, lens/data, lens/list, etc.

Browse Source
This commit is contained in:
AlexKnauth 2016-08-30 11:58:19 -04:00
parent d30fc3692f
commit 8c78864674
10 changed files with 43 additions and 9 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

2
lens-doc/lens/private/dict/dict.scrbl
View File

@ -5,6 +5,8 @@
@title[#:tag "dict-reference"]{Dict lenses}
@defmodule[lens/data/dict]
@see-guide-note["dict-guide"]{dictionary lenses}
@defproc[(dict-ref-lens [key any/c]) lens?]{

2
lens-doc/lens/private/hash/main.scrbl
View File

@ -5,6 +5,8 @@
@title[#:tag "hash-reference"]{Hash Lenses}
@defmodule[lens/data/hash]
@see-guide-note["hash-guide"]{hash lenses}
@scribble-include/no-subsection["ref.scrbl"]

2
lens-doc/lens/private/list/main.scrbl
View File

@ -4,6 +4,8 @@
@title[#:tag "pair-list-reference"]{Pair and List Lenses}
@defmodule[lens/data/list]
@see-guide-note["pair-list-guide"]{pair and list lenses}
@include-section["car-cdr.scrbl"]

11
lens-doc/lens/private/scribblings/reference.scrbl
View File

@ -4,13 +4,6 @@
@local-table-of-contents[]
@include-section[(lib "lens/private/base/main.scrbl")]
@include-section[(lib "lens/private/compound/main.scrbl")]
@include-section["../list/main.scrbl"]
@include-section["../hash/main.scrbl"]
@include-section["../struct/main.scrbl"]
@include-section["../vector/main.scrbl"]
@include-section["../string/main.scrbl"]
@include-section["../stream/stream.scrbl"]
@include-section["../dict/dict.scrbl"]
@include-section["reference/common.scrbl"]
@include-section["reference/data.scrbl"]
@include-section["../../applicable.scrbl"]

11
lens-doc/lens/private/scribblings/reference/common.scrbl Normal file
View File

@ -0,0 +1,11 @@
#lang scribble/manual
@title[#:tag "lens-common-reference"]{Lens Operations}
@defmodule[lens/common]{
Provides core lens functions and other non-data-specific lens
operations.
}
@include-section[(lib "lens/private/base/main.scrbl")]
@include-section[(lib "lens/private/compound/main.scrbl")]

16
lens-doc/lens/private/scribblings/reference/data.scrbl Normal file
View File

@ -0,0 +1,16 @@
#lang scribble/manual
@title[#:tag "lens-data-reference"]{Lenses for different types of data}
@defmodule[lens/data]{
Provides lenses and lens operations for different types of data, such
as lists and structs.
}
@include-section["../../list/main.scrbl"]
@include-section["../../hash/main.scrbl"]
@include-section["../../struct/main.scrbl"]
@include-section["../../vector/main.scrbl"]
@include-section["../../string/main.scrbl"]
@include-section["../../stream/stream.scrbl"]
@include-section["../../dict/dict.scrbl"]

2
lens-doc/lens/private/stream/stream.scrbl
View File

@ -5,6 +5,8 @@
@title[#:tag "streams-reference"]{Stream Lenses}
@defmodule[lens/data/stream]
@see-guide-note["streams-guide"]{stream lenses}
@defthing[stream-first-lens lens?]{

2
lens-doc/lens/private/string/main.scrbl
View File

@ -4,5 +4,7 @@
@title[#:tag "strings-reference"]{String Lenses}
@defmodule[lens/data/string]
@scribble-include/no-subsection["string.scrbl"]
@scribble-include/no-subsection["join-string.scrbl"]

2
lens-doc/lens/private/struct/main.scrbl
View File

@ -5,6 +5,8 @@
@title[#:tag "struct-reference"]{Struct Lenses}
@defmodule[lens/data/struct]
@see-guide-note["struct-guide"]{struct lenses}
@scribble-include/no-subsection["field.scrbl"]

2
lens-doc/lens/private/vector/main.scrbl
View File

@ -4,6 +4,8 @@
@title[#:tag "vectors-reference"]{Vector lenses}
@defmodule[lens/data/vector]
@scribble-include/no-subsection["ref.scrbl"]
@scribble-include/no-subsection["nested.scrbl"]
@scribble-include/no-subsection["pick.scrbl"]