Menu

#886 doctools - html backend - backslashes wrong in doc example

open
doctools (48)
9
2007-03-21
2007-01-28
No

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.

Discussion

  • Andreas Kupries

    Andreas Kupries - 2007-01-29

    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.

     
  • Andreas Kupries

    Andreas Kupries - 2007-01-29
    • labels: --> doctools
    • priority: 5 --> 7
    • assigned_to: nobody --> andreas_kupries
     
  • Andreas Kupries

    Andreas Kupries - 2007-03-20
    • summary: backslashes wrong in doc example --> doctools - html backend - backslashes wrong in doc example
     
  • Andreas Kupries

    Andreas Kupries - 2007-03-21

    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

    Andreas Kupries - 2007-03-21
    • priority: 7 --> 9
     
  • Donal K. Fellows

    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

    Andreas Kupries - 2007-03-21

    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.