dataframe icon indicating copy to clipboard operation
dataframe copied to clipboard

KDoc rendering looks odd on 2024 Nightly IntelliJ

Open Jolanrensen opened this issue 1 year ago • 4 comments

image

Looks like KDocs need to be checked such that no spaces exist outside inline code blocks.

In comparison, this is what it currently looks like: image

Jolanrensen avatar Feb 12 '24 10:02 Jolanrensen

I suspect IntelliJ now leans more into their Markdown Renderer.

This renderer trims code spans:

https://github.com/JetBrains/markdown/blob/aa54cceca5c28b694dcb7c940e910612c82fa76e/src/commonMain/kotlin/org/intellij/markdown/html/GeneratingProviders.kt#L73

Making things like this look weird: image

Jolanrensen avatar Feb 28 '24 13:02 Jolanrensen

Depends on https://github.com/JetBrains/markdown/pull/150

Jolanrensen avatar Mar 04 '24 13:03 Jolanrensen

https://youtrack.jetbrains.com/issue/IDEA-348571/Markdown-KDoc-rendering-errors This will fix at least some space-trimming errors, hopefully enough to make the KDocs look okay

Jolanrensen avatar Mar 18 '24 13:03 Jolanrensen

Another nice example of how broken it is. image

Jolanrensen avatar Mar 18 '24 16:03 Jolanrensen

https://youtrack.jetbrains.com/issue/KTIJ-29221/Markdown-KDoc-space-rendering-errors is done! The KDocs look a lot better now :) (in the latest 2024.1 nightly) image

I did create a new YT issue to track the other rendering errors: https://youtrack.jetbrains.com/issue/KTIJ-29221/Markdown-KDoc-space-rendering-errors

Jolanrensen avatar Mar 26 '24 12:03 Jolanrensen