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

correct formatting of star sign in kto_trainer.mdx #2031

Merged
merged 3 commits into from
Sep 8, 2024

Conversation

mattany
Copy link
Contributor

@mattany mattany commented Sep 6, 2024

The "*" symbol in markdown doesn't show. I changed it to $\times$ so the mathematical formula is clearer

What does this PR do?

correct formatting of star sign in kto_trainer.mdx

Fixes # (issue)

Before submitting

  • [X ] This PR fixes a typo or improves the docs (you can dismiss the other checks if that's the case).

Who can review?

Anyone in the community is free to review the PR once the tests have passed. Feel free to tag
members/contributors who may be interested in your PR.

The "*" symbol in markdown doesn't show. I changed it to $\times$ so the mathematical formula is clearer
@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.

@qgallouedec
Copy link
Member

Thanks for the PR
It does not render as expected though.

image

I think you need to use \\(\\times\\)

@mattany
Copy link
Contributor Author

mattany commented Sep 7, 2024

@qgallouedec Thank you your comment! Sorry about that, this is my first time contributing. Only now I see the message from the bot. I will make corrections now until the rendered docs display correctly.

edit: I made a change now but I don't see it reflected in the docs yet. I guess it takes some time to refresh.

@qgallouedec
Copy link
Member

No worry, actually you need me to approve the CI to run so that the doc builds, that's why it just appeared. Let's wait too see if your modification give the expected result

@qgallouedec
Copy link
Member

Arf, still not. Try with \\(\times\\)

@mattany
Copy link
Contributor Author

mattany commented Sep 7, 2024

@qgallouedec

Arf, still not. Try with \\(\times\\)

done. By the way, is there a reference somewhere to the version of markdown that is used on hf?

@qgallouedec
Copy link
Member

Lgtm now! image
Thanks @mattany!

@qgallouedec qgallouedec merged commit 7a67de3 into huggingface:main Sep 8, 2024
1 check passed
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.

4 participants