scolobb
/
typed-graph
1
0
Fork 0
Code Issues Pull Requests Projects Releases Wiki Activity

State plainly that this typed interface is incomplete.

This commit is contained in:
Sergiu Ivanov 2021-10-10 17:30:21 +02:00
parent ce50034a11
commit 9a1756d956
2 changed files with 15 additions and 16 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

14
README.md
View File

@ -1,9 +1,13 @@
# Typed Interface for the Generic Graph Library # Typed Interface for the Generic Graph Library
This module provides a typed interface to the [generic graph This library provides an incomplete typed interface to the [generic
library](https://docs.racket-lang.org/graph/index.html). graph library](https://docs.racket-lang.org/graph/index.html).
This module is currently **work in progress** and multiple planned As the name says it, the graph library relies on Racket generics quite
features may still be missing. 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.

17
manual.scrbl
View File

@ -8,20 +8,15 @@
@defmodule[typed/graph] @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 @hyperlink["https://docs.racket-lang.org/graph/index.html"]{generic graph
library}. library}.
This module is currently @bold{work in progress} and multiple planned features As the name says it, the graph library relies on Racket generics quite
may still be missing. 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
Here is a list of features present in the untyped library, but @emph{absent macros, which I haven't figured out how to get working with Typed
from the typed interface}: Racket yet.
@itemlist[@item{the generic interface,}]
@itemlist[@item{vertex and edge properties.}]
@bold{TODO:} List the functions which the library currently exports.
@section{Bug reporting} @section{Bug reporting}