Scaladoc: add Wiki code blocks to Md syntax #11833
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
The idea here is that in the wild, the parts of Wiki syntax that are the most used are lists, code blocks, monospace text, and links. With this PR we now more-or-less support all of them in Markdown syntax, which means that one will be able to use it for old doc comments and get acceptable-looking output.
|
@romanowski this was an idea suggested by @smarter. I think it's a bit of a hack, but I looked through a bunch of docs of community projects and it really seems like with this PR, we can parse them reasonably even with the default syntax set to Markdown. See #11728 (comment) and below for discussion about the idea. |
|
For clarity: the changes to Scaladoc code are minimal. The parser for Wiki code blocks was adapted from Flexmark code: https://github.com/vsch/flexmark-java/blob/master/flexmark/src/main/java/com/vladsch/flexmark/parser/core/FencedCodeBlockParser.java#L23. |
romanowski
approved these changes
Mar 23, 2021
odersky
pushed a commit
to dotty-staging/dotty
that referenced
this pull request
Mar 24, 2021
…for-md Scaladoc: add Wiki code blocks to Md syntax
2 tasks
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
The idea here is that in the wild, the parts of Wiki syntax that are the most
used are lists, code blocks, monospace text, and links. With this PR we now
more-or-less support all of them in Markdown syntax, which means that one will
be able to use it for old doc comments and get acceptable-looking output.