Add some more details to the manual.
This commit is contained in:
parent
5a7431f8cf
commit
c92f488fda
1 changed files with 12 additions and 7 deletions
19
manual.scrbl
19
manual.scrbl
|
@ -10,13 +10,16 @@
|
||||||
|
|
||||||
This library provides an incomplete typed interface to the
|
This library provides an incomplete typed interface to the
|
||||||
@hyperlink["https://docs.racket-lang.org/graph/index.html"]{generic graph
|
@hyperlink["https://docs.racket-lang.org/graph/index.html"]{generic graph
|
||||||
library}.
|
library}. The following parts are @bold{not currently covered}:
|
||||||
|
|
||||||
As the name says it, the graph library relies on Racket generics quite
|
@itemlist[
|
||||||
a bit, which are not supported by Typed Racket as of 2021-10-10.
|
@item{generic graph interface,}
|
||||||
Furthermore, the graph library defines a number of cool and elegant
|
@item{generic queues (from the package @racket[gen-queue-lib]),}
|
||||||
macros, which I haven't figured out how to get working with Typed
|
@item{macros.}
|
||||||
Racket yet.
|
]
|
||||||
|
|
||||||
|
I may work on adding these in the future, but it is low priority for me as of
|
||||||
|
2021-12-21. Feel free to contribute!
|
||||||
|
|
||||||
@bold{TODO:} List the exported functions together with their types.
|
@bold{TODO:} List the exported functions together with their types.
|
||||||
|
|
||||||
|
@ -32,7 +35,9 @@ As of 2021, GitHub is owned by Microsoft, so I prefer keeping this library on
|
||||||
a different platform.
|
a different platform.
|
||||||
|
|
||||||
Do feel free to submit patches to me by E-mail: I will try my best to review
|
Do feel free to submit patches to me by E-mail: I will try my best to review
|
||||||
and apply them within a reasonable time frame.
|
and apply them within a reasonable time frame. More details on contributing in
|
||||||
|
the
|
||||||
|
@hyperlink["https://git.marvid.fr/scolobb/typed-graph/src/branch/master/README.md#submitting-patches"]{README}.
|
||||||
|
|
||||||
@section{Technical details}
|
@section{Technical details}
|
||||||
|
|
||||||
|
|
Loading…
Reference in a new issue