fix local_files_only grammar#4255
Merged
Merged
Conversation
Fix the conditional grammar in `local_files_only`. Then, since I was here, I skimmed the file for other user-facing grammar issues. I didn't read the comments, so I didn't edit those.
|
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. |
Codecov Report✅ All modified and coverable lines are covered by tests. Additional details and impacted files@@ Coverage Diff @@
## main #4255 +/- ##
==========================================
+ Coverage 75.00% 77.30% +2.30%
==========================================
Files 145 171 +26
Lines 13978 19615 +5637
==========================================
+ Hits 10484 15164 +4680
- Misses 3494 4451 +957 ☔ View full report in Codecov by Sentry. 🚀 New features to boost your workflow:
|
Collaborator
|
@bot /style |
Contributor
|
Style bot fixed some files and pushed the changes. |
Contributor
Author
Thank you! |
Contributor
|
This PR has been shipped as part of the v1.17.0 release. |
Contributor
Author
I've been released! 😈 muuuuuhahahahahaha! uh ... I mean, that's great! 👼 |
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
2 participants
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 the conditional grammar in
local_files_only. Then, since I was here, I skimmed the file for other user-facing grammar issues. I didn't read the comments, so I didn't edit those.Note
Low Risk
Documentation and error-message punctuation only; no logic or API signature changes.
Overview
This PR only updates user-facing documentation in
snapshot_download(plus a short note on_AggregatedTqdmand a comma in aLocalEntryNotFoundErrormessage). No runtime behavior changes.The meaningful fix is the
local_files_onlyparameter description: it no longer mirrorshf_hub_download’s “return the cached path if it exists” wording. It now states that whenTrue, no files are downloaded, including when they are missing fromcache_dirorlocal_dir—aligned withif not local_files_only:skipping Hubrepo_infoand the offline/cache fallback path.The rest is copy-editing in the same docstring (punctuation, a priori, “cache system”, Oxford commas) and minor Raises-section formatting.
Reviewed by Cursor Bugbot for commit 35105f2. Bugbot is set up for automated code reviews on this repo. Configure here.