Conversation
…down Scaladoc renders the standard library with `-comment-syntax:markdown` (the default since 2df8144), but a number of doc comments still used wikidoc markup, which is rendered literally. A sweep over library/src and rootdoc.txt found and fixed the following: - `'''bold'''` and leftover `**bold**` inside code spans (the earlier conversion turned `'''` into `**` even inside backticks, where markdown does not interpret it): `'''true'''` / `**true**` -> `true`, etc. - `''italic''` -> `*italic*` (Iterator). - `x^y^` superscripts -> `x<sup>y</sup>`, as already done in 113e357. - `x,,1,,` subscripts -> `x<sub>1</sub>`. Where the expression was in a code span, `<code>...</code>` is used so it keeps its code styling. - `[[target `label`]]`: in markdown mode the label is rendered as plain text, so the backticks showed up literally. Dropped them, and collapsed `[[X X]]` to `[[X]]` since the default label is the query text. - rootdoc.txt: `== Heading ==` -> `## Heading`. Co-Authored-By: Claude Fable 5 <noreply@anthropic.com>
The root package documentation is written in markdown (scaladoc parses it with the same comment syntax as the sources, markdown by default), so give it the matching extension. Co-Authored-By: Claude Fable 5 <noreply@anthropic.com>
Contributor
|
Looks ok, sync with @bvenners to avoid conflicts / ensure this doesn't regress? |
Member
Author
|
What do you think @bvenners? |
This file contains hidden or 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
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
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.
Fixes #26923.
Have you relied on LLM-based tools in this contribution?
Yes
How was the solution tested?
I looked at the generated doc pages for changed files.