Browse Source

Add some more details to the manual.

master
Sergiu Ivanov 5 months ago
parent
commit
c92f488fda
  1. 19
      manual.scrbl

19
manual.scrbl

@ -10,13 +10,16 @@
This library provides an incomplete typed interface to the
@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
a bit, which are not supported by Typed Racket as of 2021-10-10.
Furthermore, the graph library defines a number of cool and elegant
macros, which I haven't figured out how to get working with Typed
Racket yet.
@itemlist[
@item{generic graph interface,}
@item{generic queues (from the package @racket[gen-queue-lib]),}
@item{macros.}
]
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.
@ -32,7 +35,9 @@ As of 2021, GitHub is owned by Microsoft, so I prefer keeping this library on
a different platform.
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}

Loading…
Cancel
Save