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

Asterisks in KDoc cause the chunk of text to be ripped off #1368

Closed
BarkingBad opened this issue Aug 22, 2020 · 2 comments · Fixed by #1376
Closed

Asterisks in KDoc cause the chunk of text to be ripped off #1368

BarkingBad opened this issue Aug 22, 2020 · 2 comments · Fixed by #1376
Assignees
Labels

Comments

@BarkingBad
Copy link
Contributor

/**
 * The abstract syntax tree node for a multiplying expression.  A multiplying
 * expression is a binary expression where the operator is a multiplying operator
 * such as "*", "/", or "mod".  A simple example would be "5*x".
 */

is rendered without at leas italic body (though it should ignore making it italic since there is no whitespace before and after asterisk)

The abstract syntax tree node for a multiplying expression. A multiplying expression is a binary expression where the operator is a multiplying operator such as "x".
@BarkingBad BarkingBad added the bug label Aug 22, 2020
@BarkingBad BarkingBad self-assigned this Aug 22, 2020
@tom5079
Copy link

tom5079 commented Aug 24, 2020

it should ignore making it italic since there is no whitespace before and after [the asterisk]

The CommonMark Spec specifies that

A single * character can open emphasis iff (if and only if) it is part of a left-flanking delimiter run.
A single * character can close emphasis iff it is part of a right-flanking delimiter run.

Thus, it should be rendered as italic.

Even the Github markdown parser parses it as italic.
such as "", "/", or "mod". A simple example would be "5x".

Guess it's not the only problem here tho.

@BarkingBad
Copy link
Contributor Author

I found out that recently. To render that as an italic is the easy fix. There is still one bug related to escaping those characters will I will look into

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

Successfully merging a pull request may close this issue.

3 participants