[Top][All Lists]

[Date Prev][Date Next][Thread Prev][Thread Next][Date Index][Thread Index]

@defun and @defvr in the "same" block?

From: Raymond Toy
Subject: @defun and @defvr in the "same" block?
Date: Mon, 21 Nov 2022 11:37:10 -0800

I'm converting some old documents written with Scribe.  The conversion is pretty straightforward since the syntax between Scribe and Texinfo are really pretty close.

However, I've run into a small issue.  The original Scribe did things like:

@defun[fun {check-region-query-size}, args {@i[region]}]
@defhvar1[var {Region Query Size}, val {30}]
@f[check-region-query-size] counts the lines in @i[region], and if their number

This basically looks like as if I'd done defunx, except Region Query Size is marked as a Hemlock Variable.

My translation is

@deffn {Function} {check-region-query-size} {@i{region}}
@deffnx {Hemlock Variable} {Region Query Size} @val{30}
@end deffn

The output matches the Scribe output.  But Region Query Size is in the Function Index, and not the Variable Index.

Is the only way to fix this is to use separate these two out and use @defvr for Region Query Size and potentially rewrite the description to match?

Rewriting is probably more than I want to do; I'm just doing the translation so I can get an HTML version of the doc.


reply via email to

[Prev in Thread] Current Thread [Next in Thread]