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

(nit) Fix <Tip> style in docs #2336

Closed
wants to merge 1 commit into from
Closed

Conversation

Wauplin
Copy link
Contributor

@Wauplin Wauplin commented Nov 19, 2024

When using the doc-builder, one must add newlines inside the <Tip> section to make it compatible with markdown styling (don't know if it's a feature or a bug, but that's how it is ^^).

That's how it currently looks without this PR:
image

With this PR:

image

@HuggingFaceDocBuilderDev

The docs for this PR live here. All of your documentation changes will be reflected on that endpoint. The docs are available until 30 days after the last update.

@rwightman
Copy link
Collaborator

going to keep for now as this is probably least troubling in terms of rendered output but would rather stick with a more standard approach for the docstring, and not add extr whitespace.

@rwightman rwightman closed this Dec 5, 2024
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.

3 participants