Tcl Library Source Code

View Ticket
Login
Ticket UUID: 1646625
Title: doctools - html backend - backslashes wrong in doc example
Type: Bug Version: None
Submitter: dkf Created on: 2007-01-28 22:12:22
Subsystem: doctools Assigned To: andreas_kupries
Priority: 9 Immediate Severity:
Status: Open Last Modified: 2007-03-21 23:18:12
Resolution: None Closed By:
    Closed on:
Description:
Looking at http://tcllib.sourceforge.net/doc/des.html I see that the backslashes in the example are doubled. This has proved very confusing to at least one user, and caused him to have needless problems.
User Comments: andreas_kupries added on 2007-03-21 23:18:12:
Logged In: YES 
user_id=75003
Originator: NO

Donal, not sure why you seem to think that I am bothered about something. I added the examples as a reminder to myself of the test cases I should use to investigate the problem, i.e. trace it through the layers of processing, and later for the test suite.

dkf added on 2007-03-21 18:37:14:
Logged In: YES 
user_id=79902
Originator: YES

I'm not bothered what the origin of the problem is; I'm bothered that the output is misleading users of the documentation. How you resolve it is your business. :-)

andreas_kupries added on 2007-03-21 08:30:30:
Logged In: YES 
user_id=75003
Originator: NO

Examples to check out

[example {
    a \
    b
}]

[example {
    a \\
    b
}]

[example_begin]
    a \
    b
[example_end]

[example_begin]
    a \\
    b
[example_end]

andreas_kupries added on 2007-01-30 01:56:44:
Logged In: YES 
user_id=75003
Originator: NO

The confusion is that the double-\ is in the output, right ?
In the input I am likely needing the double-\ to prevent interpretation as continuation line.
That is a doctools problem, in the generator for HTML output.