[Doc]: fix various typos in different files (#3509)

Author: didier-durand

docs/source/en/guides/jobs.md

@@ -172,7 +172,7 @@ Running this will show the following output!
 This code ran with the following GPU: NVIDIA A10G
 ```
 
-Use this to run a fine tuning script like [trl/scripts/sft.py](https://github.com/huggingface/trl/blob/main/trl/scripts/sft.py) with UV:
+Use this to run a fine-tuning script like [trl/scripts/sft.py](https://github.com/huggingface/trl/blob/main/trl/scripts/sft.py) with UV:
 
 ```python
 >>> from huggingface_hub import run_uv_job

docs/source/en/guides/manage-spaces.md

@@ -10,7 +10,7 @@ In this guide, we will see how to manage your Space runtime
 
 ## A simple example: configure secrets and hardware.
 
-Here is an end-to-end example to create and setup a Space on the Hub.
+Here is an end-to-end example to create and set up a Space on the Hub.
 
 **1. Create a Space on the Hub.**
 

src/huggingface_hub/_space_api.py

@@ -111,7 +111,7 @@ class SpaceRuntime:
             Current hardware of the space. Example: "cpu-basic". Can be `None` if Space
             is `BUILDING` for the first time.
         requested_hardware (`str` or `None`):
-            Requested hardware. Can be different than `hardware` especially if the request
+            Requested hardware. Can be different from `hardware` especially if the request
             has just been made. Example: "t4-medium". Can be `None` if no hardware has
             been requested yet.
         sleep_time (`int` or `None`):

src/huggingface_hub/file_download.py

@@ -1034,7 +1034,7 @@ def _hf_hub_download_to_cache_dir(
     locks_dir = os.path.join(cache_dir, ".locks")
     storage_folder = os.path.join(cache_dir, repo_folder_name(repo_id=repo_id, repo_type=repo_type))
 
-    # cross platform transcription of filename, to be used as a local file path.
+    # cross-platform transcription of filename, to be used as a local file path.
     relative_filename = os.path.join(*filename.split("/"))
     if os.name == "nt":
         if relative_filename.startswith("..\\") or "\\..\\" in relative_filename:
@@ -1531,7 +1531,7 @@ def get_hf_file_metadata(
     # Return
     return HfFileMetadata(
         commit_hash=response.headers.get(constants.HUGGINGFACE_HEADER_X_REPO_COMMIT),
-        # We favor a custom header indicating the etag of the linked resource, and we fallback to the regular etag header.
+        # We favor a custom header indicating the etag of the linked resource, and we fall back to the regular etag header.
         etag=_normalize_etag(
             response.headers.get(constants.HUGGINGFACE_HEADER_X_LINKED_ETAG) or response.headers.get("ETag")
         ),

src/huggingface_hub/hub_mixin.py

@@ -117,7 +117,7 @@ class ModelHubMixin:
             Tags to be added to the model card. Used to generate model card. E.g. ["computer-vision"]
         coders (`dict[Type, tuple[Callable, Callable]]`, *optional*):
             Dictionary of custom types and their encoders/decoders. Used to encode/decode arguments that are not
-            jsonable by default. E.g dataclasses, argparse.Namespace, OmegaConf, etc.
+            jsonable by default. E.g. dataclasses, argparse.Namespace, OmegaConf, etc.
 
     Example:
 

src/huggingface_hub/utils/_git_credential.py

@@ -111,7 +111,7 @@ def _parse_credential_output(output: str) -> list[str]:
         output (`str`):
             The output of `git credential fill`.
     """
-    # NOTE: If user has set an helper for a custom URL, it will not be caught here.
+    # NOTE: If user has set a helper for a custom URL, it will not be caught here.
     #       Example: `credential.https://huggingface.co.helper=store`
     #       See: https://github.com/huggingface/huggingface_hub/pull/1138#discussion_r1013324508
     return sorted(  # Sort for nice printing

tests/test_hf_api.py

@@ -837,7 +837,7 @@ def test_commit_preflight_on_lots_of_lfs_files(self, repo_url: RepoUrl):
     def test_create_commit_repo_id_case_insensitive(self):
         """Test create commit but repo_id is lowercased.
 
-        Regression test for #1371. Hub API is already case insensitive. Somehow the issue was with the `requests`
+        Regression test for #1371. Hub API is already case-insensitive. Somehow the issue was with the `requests`
         streaming implementation when generating the ndjson payload "on the fly". It seems that the server was
         receiving only the first line which causes a confusing "400 Bad Request - Add a line with the key `lfsFile`,
         `file` or `deletedFile`". Passing raw bytes instead of a generator fixes the problem.
@@ -3958,7 +3958,7 @@ def test_create_collection_exists_ok(self) -> None:
 
         self.assertEqual(collection_1.slug, collection_2.slug)
         self.assertIsNone(collection_1.description)
-        self.assertIsNone(collection_2.description)  # Did not got updated!
+        self.assertIsNone(collection_2.description)  # Did not get updated!
 
     def test_create_private_collection(self) -> None:
         collection = self._api.create_collection(self.title, private=True)

tests/test_utils_cache.py

@@ -50,7 +50,7 @@ class TestValidCacheUtils(unittest.TestCase):
 
     @with_production_testing
     def setUp(self) -> None:
-        """Setup a clean cache for tests that will remain valid in all tests."""
+        """Set up a clean cache for tests that will remain valid in all tests."""
         # Download latest main
         snapshot_download(repo_id=MODEL_ID, repo_type="model", cache_dir=self.cache_dir)
 
@@ -71,7 +71,7 @@ def test_scan_cache_on_valid_cache_unix(self) -> None:
         """Scan the cache dir without warnings (on unix-based platform).
 
         This test is duplicated and adapted for Windows in `test_scan_cache_on_valid_cache_windows`.
-        Note: Please make sure to updated both if any change is made.
+        Note: Please make sure to update both if any change is made.
         """
         report = scan_cache_dir(self.cache_dir)
 
@@ -104,7 +104,7 @@ def test_scan_cache_on_valid_cache_unix(self) -> None:
         self.assertEqual(sum(rev.nb_files for rev in repo_a.revisions), 6)
 
         # 2 REFS in the repo: "main" and "refs/pr/1"
-        # We could have add a tag as well
+        # We could have added a tag as well
         self.assertEqual(set(repo_a.refs.keys()), {"main", REF_1_NAME})
         self.assertEqual(repo_a.refs["main"].commit_hash, REPO_A_MAIN_HASH)
         self.assertEqual(repo_a.refs[REF_1_NAME].commit_hash, REPO_A_PR_1_HASH)
@@ -139,7 +139,7 @@ def test_scan_cache_on_valid_cache_unix(self) -> None:
         pr_1_readme_file = [file for file in pr_1_revision.files if file.file_name == "README.md"][0]
         pr_1_readme_file_path = pr_1_revision_path / "README.md"
 
-        # file_path in "refs/pr/1" revision is different than "main" but same blob path
+        # file_path in "refs/pr/1" revision is different from "main" but same blob path
         self.assertEqual(pr_1_readme_file.file_path, pr_1_readme_file_path)  # different
         self.assertEqual(pr_1_readme_file.blob_path, main_readme_blob_path)  # same
 
@@ -150,7 +150,7 @@ def test_scan_cache_on_valid_cache_windows(self) -> None:
         Windows tests do not use symlinks which leads to duplication in the cache.
         This test is duplicated from `test_scan_cache_on_valid_cache_unix` with a few
         tweaks specific to windows.
-        Note: Please make sure to updated both if any change is made.
+        Note: Please make sure to update both if any change is made.
         """
         report = scan_cache_dir(self.cache_dir)
 
@@ -183,7 +183,7 @@ def test_scan_cache_on_valid_cache_windows(self) -> None:
         self.assertEqual(sum(rev.nb_files for rev in repo_a.revisions), 6)
 
         # 2 REFS in the repo: "main" and "refs/pr/1"
-        # We could have add a tag as well
+        # We could have added a tag as well
         REF_1_NAME = "refs\\pr\\1"  # Windows-specific
         self.assertEqual(set(repo_a.refs.keys()), {"main", REF_1_NAME})
         self.assertEqual(repo_a.refs["main"].commit_hash, REPO_A_MAIN_HASH)
@@ -220,7 +220,7 @@ def test_scan_cache_on_valid_cache_windows(self) -> None:
         pr_1_readme_file = [file for file in pr_1_revision.files if file.file_name == "README.md"][0]
         pr_1_readme_file_path = pr_1_revision_path / "README.md"
 
-        # file_path in "refs/pr/1" revision is different than "main"
+        # file_path in "refs/pr/1" revision is different from "main"
         # Windows-specific: even blob path is different
         self.assertEqual(pr_1_readme_file.file_path, pr_1_readme_file_path)
         self.assertNotEqual(  # Windows-specific: different as well
@@ -237,7 +237,7 @@ class TestCorruptedCacheUtils(unittest.TestCase):
 
     @with_production_testing
     def setUp(self) -> None:
-        """Setup a clean cache for tests that will get corrupted/modified in tests."""
+        """Set up a clean cache for tests that will get corrupted/modified in tests."""
         # Download latest main
         snapshot_download(repo_id=MODEL_ID, repo_type="model", cache_dir=self.cache_dir)
 
@@ -676,7 +676,7 @@ def test_delete_path_on_folder_success(self) -> None:
         self.assertFalse(file_path_2.exists())
 
     def test_delete_path_on_missing_file(self) -> None:
-        """Try delete a missing file."""
+        """Try to delete a missing file."""
         file_path = self.cache_dir / "file.txt"
 
         with self.assertLogs() as captured:
@@ -687,7 +687,7 @@ def test_delete_path_on_missing_file(self) -> None:
         assert any(f"Couldn't delete TYPE: file not found ({file_path})" in log for log in captured.output)
 
     def test_delete_path_on_missing_folder(self) -> None:
-        """Try delete a missing folder."""
+        """Try to delete a missing folder."""
         dir_path = self.cache_dir / "folder"
 
         with self.assertLogs() as captured:
@@ -699,7 +699,7 @@ def test_delete_path_on_missing_folder(self) -> None:
 
     @xfail_on_windows(reason="Permissions are handled differently on Windows.")
     def test_delete_path_on_local_folder_with_wrong_permission(self) -> None:
-        """Try delete a local folder that is protected."""
+        """Try to delete a local folder that is protected."""
         dir_path = self.cache_dir / "something"
         dir_path.mkdir()
         file_path_1 = dir_path / "file.txt"  # file at root