docs(markdown): parse :::note's text as MD elements #32510
+7
−6
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
This comment has been minimized.
This comment has been minimized.
dgozman
approved these changes
Sep 9, 2024
dgozman
reviewed
Sep 9, 2024
mxschmitt
force-pushed
the
fix-markdown-notes
branch
2 times, most recently
from
5acc78d
to
cdd5bd5
Compare
This comment has been minimized.
This comment has been minimized.
This comment has been minimized.
This comment has been minimized.
mxschmitt
force-pushed
the
fix-markdown-notes
branch
from
cdd5bd5
to
3bbd7de
Compare
This comment has been minimized.
This comment has been minimized.
mxschmitt
force-pushed
the
fix-markdown-notes
branch
3 times, most recently
from
6d335ea
to
85b9b49
Compare
mxschmitt
force-pushed
the
fix-markdown-notes
branch
from
85b9b49
to
0d97fc4
Compare
This comment has been minimized.
This comment has been minimized.
dgozman
reviewed
Sep 11, 2024
| result.push(wrapText(node.text, options, indent)); | ||
| const children = node.children || []; | ||
| for (const child of children) | ||
| innerRenderMdNode(indent, child, children[children.length - 1], result, options); |
There was a problem hiding this comment.
Looking at other calls of innerRenderMdNode, I think that lastNode actually means previousNode, so you should pass the previous node from the children array.
| @@ -802,12 +802,12 @@ function generateSourceCodeComment(spec) { | |||
| node.codeLang = parseCodeLang(node.codeLang).highlighter; | |||
| if (node.type === 'note') { | |||
| // @ts-ignore | |||
| node.type = 'text'; | |||
| node.text = '**NOTE** ' + node.text; | |||
| node.type = 'text' | |||
| node.type = 'text'; | ||
| node.text = '**NOTE** ' + node.text; | ||
| node.type = 'text' | ||
| node.text = `**NOTE** ` + (node.children || []).map(child => md.render([child], { flattenText: false, omitLastCR: true })).join('↵') |
There was a problem hiding this comment.
I'd recommend adding a new rendering option renderNoteAs: '**NOTE** ' instead, and remove special handling of notes in this method entirely.
Test results for "tests 1"1 failed 35407 passed, 660 skipped Merge workflow run. |
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.
Two ways of fixing it, either:
a) Pass
flattenText: falasetowrapText's options, but it seems to come from high up and overriding it only for:::noteseems not great.b) Parse the
:::note's children as real MarkdownNotes and render them as real notesI did b) in this case, which seems more reasonable.
Fixes #32505
Preview of the rolled docs: microsoft/playwright.dev#1503