Summary

Procedures grouping in the wiki is confusing

Metadata

Description

Compared to the source file of the documentation, or to chickadee, the wiki is very confusing when showing grouping of multiple procedures.

It groups procedures even when they are separated by a new line in the source, which looks like these procedures are linked together even when they are not.

As an example, look at the ncurses egg documentation, more precisely at the halfdelay procedure.

https://wiki.call-cc.org/eggref/4/ncurses https://api.call-cc.org/doc/ncurses

In the wiki, it’s grouped with has_colors, has_ic and has_il, and everything is documented to return a boolean value.

In chickadee, halfdelay is by itself, and only has_colors, has_ic and has_il are grouped together with their documentation entry.

Changes and comments

[2018-08-31 23:45:30 UTC] mario changed milestone from 5.0 to someday

[2018-09-01 20:57:14 UTC] sjamaan wrote:

Looks like the rules in `qwiki-sxml` discard the def grouping:

 (import (chicken port) svnwiki-sxml)
 
 (call-with-input-string "fofo\n\n<procedure>first</procedure>\n\n\n<procedure>second</procedure>\n<procedure>third</procedure>\nbar" svnwiki->sxml)
 ;; => ((p "fofo")
 ;;     (def (sig (procedure "first")))
 ;;     (def (sig (procedure "second") (procedure "third"))
 ;;     (p "bar")))

The really strange thing is of course that there's nothing following the def. We could convert the `def` itself to a div or something like that, and give that a class that can be targeted to create some space.

Of course, this is all just a lot of effort for missing documentation for a procedure here :)

[2018-09-01 20:59:22 UTC] sjamaan wrote:

The sxml above gets converted to HTML like this:

 <p>fofo</p>
 <span class="definition procedure"><em>[procedure]</em> <tt>first</tt>
 <br></span>
 <span class="definition procedure"><em>[procedure]</em> <tt>second</tt>
 <br></span>
 <span class="definition procedure"><em>[procedure]</em> <tt>third</tt>
 <br></span>
 <p>bar</p>