Browse Source

Start listing the exported types.

master
Sergiu Ivanov 5 months ago
parent
commit
a8345b1920
  1. 22
      manual.scrbl

22
manual.scrbl

@ -1,6 +1,8 @@
#lang scribble/manual
@(require (for-label (only-in typed/racket require/typed require/typed/provide)))
@(require (for-label (only-in typed/racket require/typed require/typed/provide))
(for-label (only-in graph (graph? g:graph?)))
(for-label typed/graph))
@title{Typed Interface for the Generic Graph Library}
@ -21,8 +23,6 @@ library}. The following parts are @bold{not currently covered}:
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.
@section{Bug reporting}
If you find a bug, first try running your code directly with the graph library,
@ -51,6 +51,22 @@ This solution comes from Alex Knauth's answer
@hyperlink["https://stackoverflow.com/a/65416020"]{answer on Stack Overflow}.
This page also contains a technical explanation of the issue.
@section{Exported types}
This section lists the types this library gives to re-exported functions.
The subsections correspond to the sections of the documentation of the generic
graph library.
@defidform[Graph]{
The opaque type corresponding to the predicate @racketlink[g:graph? "graph?"].
}
@subsection{Generic Graph Interface}
@defproc[(has-vertex? [g Graph] [v Any]) Boolean]{}
@section{License}
Like the generic graph library, this library is licensed under the Apache

Loading…
Cancel
Save