You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
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!
The text was updated successfully, but these errors were encountered:
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:
This code block is a valid example, but when rendered to the webpage we end up with:
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!
The text was updated successfully, but these errors were encountered: