Skip to content

Conversation

@albertvillanova
Copy link
Member

Fix wrong formatting done by make precommit on docstrings containing blockquote tips (e.g. > [!WARNING]):

  • Ignore docstyle in docstrings with blockquote tips

Currently, make precommit executes doc-builder style --max_len 119 and this converts

"""
> [!WARNING]
> This is my warning message.
"""

to

"""
> [!WARNING] > This is my warning message.
"""

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-ignore comments to the docstrings containing blcokquote tips. This ensures that documentation style checkers will skip these docstrings until the issue is fixed in doc-builder.

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

@albertvillanova albertvillanova merged commit e5d437e into huggingface:main Oct 1, 2025
9 of 10 checks 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.

3 participants