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

docs: small fixes in docs #245

Merged
merged 1 commit into from
Jan 17, 2025

Conversation

MoritzLaurer
Copy link
Contributor

Two very minor fixes:

  • one example in the docs requires trust_remote_code=True to run correctly
  • a small formatting update in the docstrings

Copy link
Member

@albertvillanova albertvillanova left a comment

Choose a reason for hiding this comment

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

Thanks for the fix with trust_remote_code.

Regarding the docstring fixes, since we're not currently using doctest, I’m not sure they serve a purpose in this context.

@MoritzLaurer
Copy link
Contributor Author

The idea with the doctest syntax is to align it with the syntax in other docstrings like this one where it's already used (I also added the ```py for better syntax highlighting):

I'm not attached to the doctest syntax, just wanted to make it consistent

Copy link
Member

@albertvillanova albertvillanova left a comment

Choose a reason for hiding this comment

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

You are right, even if we are not currently using doctest, we may in the future.

@albertvillanova albertvillanova merged commit 7d6599e into huggingface:main Jan 17, 2025
4 checks passed
@MoritzLaurer MoritzLaurer deleted the small-docs-fixes branch January 17, 2025 18:29
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.

2 participants