From a8345b1920b3a02bd86441184aabbc5114cac0c4 Mon Sep 17 00:00:00 2001 From: Sergiu Ivanov Date: Thu, 23 Dec 2021 11:50:06 +0100 Subject: [PATCH] Start listing the exported types. --- manual.scrbl | 22 +++++++++++++++++++--- 1 file changed, 19 insertions(+), 3 deletions(-) diff --git a/manual.scrbl b/manual.scrbl index 8e7e1c3..7bd4b31 100644 --- a/manual.scrbl +++ b/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