Repository navigation
fix(markdown): cap section header depth at six heading levels - #872
Conversation
…adings Signed-off-by: RavSinghChandan <[email protected]>
|
✅ DCO Check Passed Thanks @RavSinghChandan, all your commits are properly signed off. 🎉 |
Merge Protections🟢 All 2 merge protections satisfied — ready to merge. Show 2 satisfied protections🟢 Enforce conventional commitMake sure that we follow https://www.conventionalcommits.org/en/v1.0.0/
🟢 Require two reviewer for test updatesWhen test data is updated, we require two reviewers
|
Codecov Report✅ All modified and coverable lines are covered by tests. 📢 Thoughts on this report? Let us know! |
ceberam
added
bug
ceberam
changed the title
ceberam
left a comment
ceberam
left a comment
There was a problem hiding this comment.
Thanks for the contribution, @RavSinghChandan. This is a small, focused fix and it does what it claims. I only have minor, non-blocking suggestions (mainly the docstring) and I don't see anything that blocks merging.
Signed-off-by: RavSinghChandan <[email protected]>
ceberam
left a comment
ceberam
left a comment
There was a problem hiding this comment.
Thanks @RavSinghChandan for the small changes to the documentation. All good 🚀
|
Thanks for the review! |
…adingsThe Markdown serializer writes a section header of level N with N + 1
#, so a header at level 6 or deeper became#######or more. Markdown only has six heading levels, so those lines render as plain text starting with hashes ("######## Deep") instead of headings. The HTML serializer already caps these at<h6>.The number of
#is now capped at 6, so deep section headers stay level-6 headings. Levels 1-5 are unchanged. Addedtest_md_deep_section_headers_stay_headings.