Preserve Markdown callout blockquote lines in docbuilder style docstring formatting#756
Open
qgallouedec wants to merge 4 commits intohuggingface:mainfrom
Open
Preserve Markdown callout blockquote lines in docbuilder style docstring formatting#756qgallouedec wants to merge 4 commits intohuggingface:mainfrom
docbuilder style docstring formatting#756qgallouedec wants to merge 4 commits intohuggingface:mainfrom
Conversation
albertvillanova
approved these changes
Feb 25, 2026
Member
albertvillanova
left a comment
There was a problem hiding this comment.
Thanks! Much better.
Just a question: are we sure that the regex does not match unintended text?
Member
Author
|
I'm not an expert in regex, but let me look into it. |
Member
Author
|
The only case I can think of is text = """Shell snippet written outside fenced code:
> This is just a normal quote line that is intentionally very very very very very very very very very very very very long and would usually be wrapped.
"""
print(style_docstring(text, 119)[0])where we would like to get something like but we get which is not a big deal I think, cause before this PR: |
Member
Author
|
Addressed here: #757 |
Wauplin
approved these changes
Mar 3, 2026
| # Re pattern that matches blockquote tip markers: > [!NOTE], > [!TIP], > [!IMPORTANT], > [!WARNING], > [!CAUTION] | ||
| _re_blockquote_tip = re.compile(r"^\s*> \[!(?:NOTE|TIP|IMPORTANT|WARNING|CAUTION)\]\s*$") | ||
| # Re pattern that catches markdown blockquote lines. | ||
| _re_blockquote_tip = re.compile(r"^\s*>\s?.*$") |
Contributor
There was a problem hiding this comment.
Suggested change
| _re_blockquote_tip = re.compile(r"^\s*>\s?.*$") | |
| _re_blockquote = re.compile(r"^\s*>\s?.*$") |
(nit) (not catching only tips anymore)
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
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.
Before this PR:
After this PR: