Skip to content

Conversation

cyyever
Copy link
Contributor

@cyyever cyyever commented Sep 26, 2025

What does this PR do?

As the title says.

Before submitting

  • This PR fixes a typo or improves the docs (you can dismiss the other checks if that's the case).
  • Did you read the contributor guideline,
    Pull Request section?
  • Was this discussed/approved via a Github issue or the forum? Please add a link
    to it if that's the case.
  • Did you make sure to update the documentation with your changes? Here are the
    documentation guidelines, and
    here are tips on formatting docstrings.
  • Did you write any new necessary tests?

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.

Signed-off-by: Yuanyuan Chen <cyyever@outlook.com>
@Rocketknight1
Copy link
Member

cc @stevhliu!

@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.

Copy link
Member

@stevhliu stevhliu left a comment

Choose a reason for hiding this comment

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

Hmm, the formatting looks incorrect compared to before (your changes on the left below) ?

Image

@cyyever
Copy link
Contributor Author

cyyever commented Sep 27, 2025

@stevhliu I am sure that $...$ is a widely supported flavour for inline Latex math formulas in markdown files (.md or .mdx), as Google and other MD editors/viewers/linters suggest. However, our documentation is generated by doc-builder, which recognises only \\( .... \\) in preprocessing.
A better approach is patching it to support both $...$ and \\( ... \\), it is not hard and may I propose a PR there and seek your review?

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