Suppresses header check inside frontmatter #14203
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
|
Thanks for making a pull request to jupyterlab! |
front: matter^^^ that's some frontmatter Ha, hadn't even looked at the implementation... figured it actually used the markdown parser or something. That's a lot of heuristics. But this is markdown, which seems to be made entirely of heuristics. The changed seems reasonable, but I imagine some more cases around the .rst-like/ ---
front: matter
---
Not-front-matter
===
Really-not-front-matter
---
Not even looking
~~~
> ^^^ this is probably an alternate code block
|
|
Oh, and the (very whitespace-sensitive) "semantic break" that makes a |
|
@bollwyvl Since this is front matter, should we only do the frontmatter check once, on the very first line of the file? That would prevent the horizontal rule |
|
thanks @JasonWeill
Yes we should only check for the very first line; switch to a logic:
Another reason is that your current implementation will not work with the following case: I'm pretty sure the current logic will escape the second title. I'm 👍 for reusing the markdown parsing (especially as we are already parsing twice the string, once by CM and once by marked.js). But let's open a follow-up issue as it will require more complex changes. |
|
Yep: I guess we're trying to match upstream GFM: here are some weird cases: https://gist.github.com/bollwyvl/84f19e4bcb3a6d5a8d23a26a5bcaf329 Here are some weird edge cases. |
JasonWeill
force-pushed
the
toc-frontmatter
branch
from
fc80fa5
to
3ba23f5
Compare
fcollonval
requested changes
Mar 17, 2023
JasonWeill
force-pushed
the
toc-frontmatter
branch
from
1be1d11
to
1fca3f8
Compare
Benchmark reportThe execution time (in milliseconds) are grouped by test file, test type and browser. The mean relative comparison is computed with 95% confidence. Results table
Changes are computed with expected as reference.
Waiting for localhost:8888 Cell memory leaksCreate a code cellMemory change: +157 kB Leak detected: YesLeaking objects:
Leaking collections: Create a markdown cellMemory change: -135 kB Leak detected: NoLeaking objects:
Leaking collections: Create a raw cellMemory change: +143 kB Leak detected: YesLeaking objects:
Leaking collections: File editor memory leaksCreate a fileMemory change: -73.5 kB Leak detected: NoLeaking objects:
Notebook memory leaksCreate a notebookMemory change: +31.5 kB Leak detected: YesLeaking objects:
2 passing (6m) |
Sign up for free
to subscribe to this conversation on GitHub.
Already have an account?
Sign in.
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.
References
Fixes #14200.
Code changes
Suppresses Markdown header check inside YAML frontmatter, defined as lines surrounded by
---on a line by itself.User-facing changes
In the Markdown block below,
SummaryandMotivationare recognized as headings, and nothing in the frontmatter is.Backwards-incompatible changes
None.