Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Doc styler tip #15105

Merged
merged 2 commits into from
Jan 11, 2022
Merged

Doc styler tip #15105

merged 2 commits into from
Jan 11, 2022

Conversation

sgugger
Copy link
Collaborator

@sgugger sgugger commented Jan 11, 2022

What does this PR do?

This PR makes sure the doc styler considers the start and end of Tip blocks as paragraph-breakers. For instance

"""
<Tip>
Short tip with no new line
</Tip>
"""

is currently restyled on one line (which may or may not work with the frontend).

With this PR, it's restyled like this:

"""
<Tip>

Short tip with no new line

</Tip>
"""

I can remove the part that adds new lines if you think it's too much.

@sgugger sgugger requested a review from LysandreJik January 11, 2022 15:35
Copy link
Member

@LysandreJik LysandreJik left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Looks good to me!

@sgugger sgugger merged commit 704d1fe into master Jan 11, 2022
@sgugger sgugger deleted the doc_styler_tip branch January 11, 2022 16:45
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants