Tcl Library Source Code

View Ticket
Login
Ticket UUID: c17f7019ecde4d1a441ec36dede4af2fd7f89d74
Title: TEPAM Introduction Documentation - Markdown generation errors
Type: Bug Version: 0.5
Submitter: anonymous Created on: 2019-04-16 13:32:22
Subsystem: doctools Assigned To: aku
Priority: 7 High Severity: Severe
Status: Closed Last Modified: 2019-04-16 22:57:14
Resolution: Fixed Closed By: aku
    Closed on: 2019-04-16 22:57:14
Description:
The TEPAM Introduction page at https://core.tcl.tk/tcllib/doc/trunk/embedded/md/tcllib/files/modules/tepam/tepam_introduction.md contains a couple of errors:

1. The PROCEDURE DECLARATION section, 2nd paragraph after the example code, says "The procedure body on the other hand is identical between a command declared with proc and a command declared with procedure", but the example code contains asterisks in the body which aren't part of a normal "proc" declaration. If they're not formatting errors, the text doesn't explain them.

2. In the FLEXIBLE ARGUMENT DIALOG BOX section, the big example code is missing a trailing square bracket "]".
User Comments: aku added on 2019-04-16 22:57:14: (text/x-fossil-wiki)
Ref 2: A missing flush of accumulated expander text in `example_end` caused the bracket to become part of the plain text after the example instead of being part of it.

Ref 1: Fixed as envisioned

Fixed with commit [f5786278a4].

Version bump 1.5.5.

Thank you for the report.

aku added on 2019-04-16 17:29:23:
Wrt 1: Checking around I would say it is an issue with the markdown generator. The stars/asterisks are markdown syntax for emphasis. They are also limited to inline use, i.e. cannot cross lines, while the .man [emph] command is ok with application on multi-line text. The generator is not taking this into account and simply emits the md syntax without breaking lines apart and marking each separately.

Wrt 2: The trailing bracket is actually present. It just somehow moved to the next line, after the example. Checking ... In the .man it is definitely part of the example.  And in the generated .md it is separated from the example by a blank line. So the input is ok, and the fossil markdown rendering does the correct thing too. The issue is in the markdown generator. Again.

So, both problem are issues with the new markdown generator, and not with the manpage.