Scala Programming Language
  1. Scala Programming Language
  2. SI-4488

ScalaDoc: subscript doesn't work in code (and <sub> doesn't too)

    Details

    • Type: Bug Bug
    • Status: Closed
    • Priority: Major Major
    • Resolution: Won't Fix
    • Affects Version/s: None
    • Fix Version/s: Scala 2.10.0-M2
    • Component/s: Scaladoc Tool
    • Labels:
      None
    • Environment:

      scaladoc formatting subscript

      Description

      === What steps will reproduce the problem? ===
      Look at List#:\ and List.map3

      op(...op(op(z, x,,1,,), x,,2,,), ..., x,,n,,)
      
          [f(a<sub>0</sub>,b<sub>0</sub>,c<sub>0</sub>), ..., f(a<sub>n</sub>,b<sub>n</sub>,c<sub>n</sub>)] if the lists are [a<sub>0</sub>, ..., a<sub>k</sub>], [b<sub>0</sub>, ..., b<sub>l</sub>], [c<sub>0</sub>, ..., c<sub>m</sub>] and n = min(k,l,m) 
      

      === What is the expected behavior? ===
      Maybe it should work ... maybe it should require some sort of escape character before?

      === What do you see instead? ===
      Formatting is broken for subscript.

        Activity

        Hide
        Kato Kazuyoshi added a comment -

        `...` is syntax for a monospace element. And Scaladoc don't allow any formatting inside a monospace element.

        But is this a bug or a feature?

        Show
        Kato Kazuyoshi added a comment - `...` is syntax for a monospace element. And Scaladoc don't allow any formatting inside a monospace element. But is this a bug or a feature?
        Hide
        Kato Kazuyoshi added a comment -

        ... -> `...`

        Show
        Kato Kazuyoshi added a comment - ... -> `...`
        Hide
        Kato Kazuyoshi added a comment -

        I have a patch to fix this problem but I don't know the spec well. Can we use subscript inside monospace?

        Show
        Kato Kazuyoshi added a comment - I have a patch to fix this problem but I don't know the spec well. Can we use subscript inside monospace?
        Hide
        Kato Kazuyoshi added a comment - - edited

        Hi Donna,

        I think we should clarify the spec of Scaladoc.

        Show
        Kato Kazuyoshi added a comment - - edited Hi Donna, I think we should clarify the spec of Scaladoc.
        Hide
        Donna Mithra Malayeri added a comment -

        I'm re-assigning to Vlad who is taking over scaladoc.

        Show
        Donna Mithra Malayeri added a comment - I'm re-assigning to Vlad who is taking over scaladoc.
        Hide
        Manohar Jonnalagedda added a comment -

        The comments referred to are in fact inside code blocks. Naturally, one cannot use wiki syntax inside of code blocks.

        Show
        Manohar Jonnalagedda added a comment - The comments referred to are in fact inside code blocks. Naturally, one cannot use wiki syntax inside of code blocks.

          People

          • Assignee:
            Manohar Jonnalagedda
            Reporter:
            Simon Ochsenreither
            TracCC:
            Kato Kazuyoshi
          • Votes:
            0 Vote for this issue
            Watchers:
            4 Start watching this issue

            Dates

            • Created:
              Updated:
              Resolved:

              Development