Error codes with single quote render poorly in Markdown

[ekrich]

minimized code

[error] -- [E053] Reference Error: /Users/eric/workspace/sconfig/sconfig/shared/src/main/scala/org/ekrich/config/impl/SimpleConfig.scala:719:19 
[error] 719 |  def getEnum[T <: Enum[T]](enumClass: Class[T], path: String): T = {
[error]     |                   ^^^^^^^
[error]     |                   Enum does not take type parameters
[error] -- [E053] Reference Error: /Users/eric/workspace/sconfig/sconfig/shared/src/main/scala/org/ekrich/config/impl/SimpleConfig.scala:841:32 
[error] 841 |  private def getEnumValue[T <: Enum[T]](path: String,
[error]     |                                ^^^^^^^
[error]     |                                Enum does not take type parameters
[error] -- [E007] Type Mismatch Error: /Users/eric/workspace/sconfig/sconfig/shared/src/main/scala/org/ekrich/config/impl/SimpleConfig.scala:845:21 
[error] 845 |    try Enum.valueOf(enumClass, enumName)
[error]     |                     ^^^^^^^^^
[error]     |   Found:    Class[T](enumClass)
[error]     |   Required: Class[T']
[error]     |   
[error]     |   where:    T  is a type in method getEnumValue with bounds <: Enum
[error]     |             T' is a type variable with constraint <: Enum[LazyRef(T)]
[error] -- [E008] Member Not Found Error: /Users/eric/workspace/sconfig/sconfig/shared/src/main/scala/org/ekrich/config/impl/SimpleConfig.scala:851:37 
[error] 851 |          enumNames.add(enumConstant.name)
[error]     |                        ^^^^^^^^^^^^^^^^^
[error]     |      value name is not a member of T
[error]     |      
[error]     |      where:    T is a type in method getEnumValue with bounds <: Enum
[error] -- [E053] Reference Error: /Users/eric/workspace/sconfig/sconfig/shared/src/main/scala/org/ekrich/config/impl/SimpleConfig.scala:829:23 
[error] 829 |  def getEnumList[T <: Enum[T]](enumClass: Class[T],
[error]     |                       ^^^^^^^
[error]     |                       Enum does not take type parameters
[error] -- Error: /Users/eric/workspace/sconfig/sconfig/shared/src/main/scala/org/ekrich/config/impl/SimpleConfigObject.scala:22:37 

expectation

My hope would be that error messages like above could be modified to render nicely in Markdown since many people use UIs like GitHub.

[smarter]

Syntax highlighting on github is controlled by https://github.com/scala/vscode-scala-syntax, so maybe the highlighter could be fixed instead.

[ekrich]

Could the message just be T1 instead of T prime? Is the single tick significant?

[smarter]

The problem is that T1 could be the name of a different type parameter, the type parameter is called T and the tick is used to differentiate different parameters with the same name. Alternatively we could use Unicode subscripts to append a number, or colors.

[ekrich]

Roger, so T prime means that it is T just not the same T - got it. Do you think we should create an issue for the syntax then and maybe leave this one here for reference for the time being or close this one?

[smarter]

We could close this one for now, and reopen if we can't fix syntax highlighting.

[ekrich]

Created issue scala/vscode-scala-syntax#52

[nicolasstucki]

Possible fix scala/vscode-scala-syntax#59