Skip to content
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

["Documentation"] Ior Knit examples not rendering properly #3385

Open
noar-t opened this issue Mar 1, 2024 · 0 comments
Open

["Documentation"] Ior Knit examples not rendering properly #3385

noar-t opened this issue Mar 1, 2024 · 0 comments

Comments

@noar-t
Copy link

noar-t commented Mar 1, 2024

Some code examples that get rendered to KDoc do not have all of the characters rendered properly.

For example, within Ior.kt there exists a code block in the comments:

   * fun main() {
   *   val right: Ior<Int, Int> = Ior.Right(12)
   *   right.isLeft { it > 10 }   // Result: false
   *   Ior.Both(12, 7).isLeft { it > 10 }    // Result: false
   *   Ior.Left(12).isLeft { it > 10 }      // Result: true
   * }

This code block is a valid example, but when rendered to the webpage we end up with:

fun main() {
  val right: Ior<Int, Int> = Ior.Right(12)
  right.isLeft { it 10 }   // Result: false
  Ior.Both(12, 7).isLeft { it 10 }    // Result: false
  Ior.Left(12).isLeft { it 10 }      // Result: true
}

As far as I can tell, the problem exists within Knit. I did look briefly through the documentation there, but did not see any sorts of flags or escape characters that should be used to enable the correct behavior. Regardless, I wanted to raise the issue as it did confuse me quite a bit while I was trying to understand the API within the KDocs.

Also thanks for the awesome library!

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

1 participant