diff --git a/README.md b/README.md index adedfef..29cfd63 100644 --- a/README.md +++ b/README.md @@ -1,9 +1,13 @@ # Typed Interface for the Generic Graph Library -This module provides a typed interface to the [generic graph -library](https://docs.racket-lang.org/graph/index.html). +This library provides an incomplete typed interface to the [generic +graph library](https://docs.racket-lang.org/graph/index.html). -This module is currently **work in progress** and multiple planned -features may still be missing. +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. -For more details, refer to the Scribble documentation of the package. +Free to submit patches to me by E-mail. I will try my best to review +and apply them within a reasonable time frame. diff --git a/manual.scrbl b/manual.scrbl index 8c132cf..0028499 100644 --- a/manual.scrbl +++ b/manual.scrbl @@ -8,20 +8,15 @@ @defmodule[typed/graph] -This module provides a typed interface to the +This library provides an incomplete typed interface to the @hyperlink["https://docs.racket-lang.org/graph/index.html"]{generic graph library}. -This module is currently @bold{work in progress} and multiple planned features -may still be missing. - -Here is a list of features present in the untyped library, but @emph{absent -from the typed interface}: - -@itemlist[@item{the generic interface,}] -@itemlist[@item{vertex and edge properties.}] - -@bold{TODO:} List the functions which the library currently exports. +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. @section{Bug reporting}