From 6733eb6afa1950b17f0b91d569b08d6ece0f06ef Mon Sep 17 00:00:00 2001 From: JackFirth Date: Sat, 21 Feb 2015 00:09:38 -0800 Subject: [PATCH] Initialize docs --- doc-coverage/doc-coverage.scrbl | 22 ++++++++++++++++++++-- 1 file changed, 20 insertions(+), 2 deletions(-) diff --git a/doc-coverage/doc-coverage.scrbl b/doc-coverage/doc-coverage.scrbl index bb60066..1305e04 100644 --- a/doc-coverage/doc-coverage.scrbl +++ b/doc-coverage/doc-coverage.scrbl @@ -4,7 +4,7 @@ (for-label doc-coverage racket/base)) -@title{package-name} +@title{doc-coverage} @(define the-eval (make-base-eval)) @(the-eval '(require "main.rkt")) @@ -13,4 +13,22 @@ @author[@author+email["Jack Firth" "jackhfirth@gmail.com"]] -source code: @url["https://github.com/jackfirth/package-name"] \ No newline at end of file +This library provides functions for inspecting the number of +bindings a module exports with and without corresponding +Scribble documentation, as well as Rackunit tests based on +this information. This allows a module author to enforce in +a test suite that their modules provide no undocumented +bindings. + +source code: @url["https://github.com/jackfirth/package-name"] + +@section{Basic Module Documentation Reflection} + +@defproc[(has-docs? [mod symbol?] [binding symbol?]) boolean?]{ + Returns @racket[#t] if the module @racket[mod] provides + @racket[binding] with documentation, and @racket[#f] + otherwise. + @examples[#:eval the-eval + (has-docs? 'racket/list 'second) + (has-docs? 'racket/match 'match-...-nesting) +]} \ No newline at end of file