[racket] Documentation coverage?

From: Sam Tobin-Hochstadt (samth at cs.indiana.edu)
Date: Thu Feb 19 17:23:35 EST 2015

`check-docs` lists all the undocumented bindings; it should be pretty easy
to modify it to print the list of documented bindings too. You can see it
in action here:
http://drdr.racket-lang.org/29735/racket/share/pkgs/typed-racket-test/test-docs-complete.rkt
on the file here:
https://github.com/racket/typed-racket/blob/master/typed-racket-test/test-docs-complete.rkt

Sam

On Thu Feb 19 2015 at 5:19:52 PM Jack Firth <jackhfirth at gmail.com> wrote:

> Didn't know about that, very cool and certainly shows this is possible.
> More information would be needed, since `check-docs` one only tells you if
> everything's documented or not. I'd like something that returns a list of
> all bindings with documentation and all bindings without, and some service
> that packages that up into a nice report and github badge or some such.
>
> On Thu, Feb 19, 2015 at 2:04 PM, Alexander D. Knauth <alexander at knauth.org
> > wrote:
>
>>
>> On Feb 19, 2015, at 4:49 PM, Jack Firth <jackhfirth at gmail.com> wrote:
>>
>> > I've been using the new Racket code coverage tool that integrates with
>> Coveralls (thank you Spencer Florence!) and I was wondering - would a
>> similar tool that reports how many exported bindings of a module have
>> Scribble documentation be a good idea?
>>
>> Could this be what you’re looking for?
>>
>>
>> http://docs.racket-lang.org/rackunit/Testing_Utilities.html#%28part._.Checking_documentation_completeness%29
>>
>> I’ve never used it though.
>>
>>
>> > I'd find it very useful if the package build server reported that
>> information, especially if it also offered a similar github badge that
>> linked to the package's docs.
>> > ____________________
>> >  Racket Users list:
>> >  http://lists.racket-lang.org/users
>>
>>
> ____________________
>   Racket Users list:
>   http://lists.racket-lang.org/users
>
-------------- next part --------------
An HTML attachment was scrubbed...
URL: <http://lists.racket-lang.org/users/archive/attachments/20150219/ea08be2c/attachment.html>

Posted on the users mailing list.