Repository navigation
Hotfix wrong formatting of docstrings with blockquote tips - #4187
Merged
albertvillanova merged 1 commit intoOct 1, 2025
Merged
albertvillanova merged 1 commit into
albertvillanova merged 1 commit into
Conversation
|
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
approved these changes
Oct 1, 2025
qgallouedec
pushed a commit
that referenced
this pull request
Oct 6, 2025
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.
Fix wrong formatting done by
make precommiton docstrings containing blockquote tips (e.g.> [!WARNING]):Currently,
make precommitexecutesdoc-builder style --max_len 119and this convertsto
I have proposed a fix for hf-doc-builder:
In the meantime, consider this PR as a hotfix that we should revert once the upstream issue is fixed.
This PR primarily adds
# docstyle-ignorecomments to the docstrings containing blcokquote tips. This ensures that documentation style checkers will skip these docstrings until the issue is fixed in doc-builder.