broken online help system
Ralf Juengling <[email protected]>
| Newsgroups | gmane.lisp.lush.devel |
|---|---|
| Message-ID | <[email protected]> |
I have a question about the online-help system in lush.
I like the idea of keeping code and API documentation in one
file. I have seen that this has been done at many places in
lush. But the help-text system seems to be broken (see below).
Here is a snippet of text from libidx/idx-convol.lsh:
;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;
;; THESE ARE THE "SLOW" CONVOLUTIONS
;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;
#? *** Generic Convolutions
;; Regular 1D and 2D convolution and backconvolutions
;; for idx of doubles, floats, and ubytes.
;; Each function take 3 arguments: input, kernel, output.
;; The size of the output plus the size of the kernel
;; minus 1 must equal to the size of the input in
;; all dimensions (to prevent annoying boundary conditions).
;; The backconvolution can be seen the transposed operator
;; of the convolution.
#? (midx-m1convol <input> <kernel> <output>)
;; for 1D convolution. all arguments are idx1 (of any numerical type).
(dmd midx-m1convol (in kernel out)
`(let ((uin (unfold ,in 0 (idx-dim ,kernel 0) 1)))
(idx-m2dotm1 uin ,kernel ,out)))
First observation: I can only access the help text for functions,
not the paragraph titled "Generic Convolutions".
? ^Amidx-m1convol
------------------------------------------------------------------------
(midx-m1convol <input> <kernel> <output>) (lsh/libidx/idx-
convol.lsh)
. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
macro for 1D convolution. all arguments are idx1 (of any numerical
type).
= ()
? ^AGeneric
no match found
= ()
?
Second observation: When I change text in a module (.lsh file) and
then reload the module, the function and and class objects get updated
but not the associated help texts. More general, if I load my own
modules, the help texts in them don't become available to lush's
search facility.
I consider both phenomena bugs and want to fix them. Can anybody
tell me where to start looking? Is there documentation of the help
system itself that I might have missed?
Thanks,
Ralf
--
Ralf Juengling <[email protected]>
-------------------------------------------------------
This SF.Net email is sponsored by the JBoss Inc.
Get Certified Today * Register for a JBoss Training Course
Free Certification Exam for All Training Attendees Through End of 2005
Visit http://www.jboss.com/services/certification for more information