Indices for Hemlock implementer's manual are messed up
This is easiest to see in the PDF
doc. Go to the
Function Index and look for check-region-query-size
. This is
correct. When you visit that page, you'll notice that the next line
says Region Query Size
, which is a Hemlock variable. But it's not
listed in the Variable Index. If you look at the Function Index,
you'll find Region Query Size
.
The problem is this:
@deffn {Function} {check-region-query-size} {@i{region}}
@deffnx {Hemlock Variable} {Region Query Size} @val{30}
...
@end deffn
The original Scribe version has:
@defun[fun {check-region-query-size}, args {@i[region]}]
@defhvar1[var {Region Query Size}, val {30}]
<description>
@enddefun
So in the conversion, we changed @defun
for @deffn {Function}
, and
@defhvar1
to @deffnx {Hemlock Variable}
.
But I guess @deffn
puts everything defined with it in the Function
Index. I don't know how to fix this other than to break it into two
parts like so:
@defun {check-region-query-size} {@i{region}}
@end deffn
@defvr {Hemlock Variable} {Region Query Size} @val{30}
<description>
@end defvr
This kind of works, but there's an extra line between the two entries, kind of making it look as if they're separate. (Well, because they are.)
Other than rewriting the entry, I don't see how to fix this.