Skip to content

Scaladoc <code> tags recursively applied after code in markdown comment #11477

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Closed
KacperFKorban opened this issue Feb 19, 2021 · 1 comment · Fixed by #11612
Closed

Scaladoc <code> tags recursively applied after code in markdown comment #11477

KacperFKorban opened this issue Feb 19, 2021 · 1 comment · Fixed by #11612
Assignees
Milestone

Comments

@KacperFKorban
Copy link
Member

Description of method has a recursively applied <code> tag after the markdown code is ended, which results in a really small text.
e.g. (https://github.com/lampepfl/dotty/blob/master/library/src/scala/compiletime/package.scala)

 /** Use this method when you have a type, do not have a value for it but want to
   *  pattern match on it. For example, given a type `Tup <: Tuple`, one can
   *  pattern-match on it as follows:
   *  ```
   *  inline erasedValue[Tup] match {
   *    case _: EmptyTuple => ...
   *    case _: h *: t => ...
   *  }
   *  ```
   *  This value can only be used in an inline match and the value cannot be used in
   *  the branches.
   */
  erased def erasedValue[T]: T = ???

results in this entry:
image
https://dotty.epfl.ch/api/scala/compiletime.html#erasedValue-fffff7c4

@BarkingBad
Copy link
Contributor

The problem is in default syntax. The default syntax for stdlib libraries is WikiSyntax, yet somebody used markdown grammar, which breaks the layout. We should either normalize everything to WikiSyntax, or annotated these docs with explicit markdown syntax.

@BarkingBad BarkingBad linked a pull request Mar 5, 2021 that will close this issue
@Kordyjan Kordyjan added this to the 3.0.0 milestone Aug 2, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging a pull request may close this issue.

3 participants