Run pre-commit typos

Author: pedro-psb

README.md

@@ -43,13 +43,13 @@ pipx install git+https://github.com/pulp/pulp-docs --include-deps
 pulp-docs serve
 ```
 
-For development, use your prefered method!
+For development, use your preferred method!
 
 ## How to override `repolist.yml`
 
-If you want to share work you are doing in muliple forks, you can share a custom `repolist.yml` which points to your forks.
+If you want to share work you are doing in multiple forks, you can share a custom `repolist.yml` which points to your forks.
 
-Then, anyone can test them locally by overriting your `repolist.yml` like so:
+Then, anyone can test them locally by overwriting your `repolist.yml` like so:
 
 ```bash
 $ cat "path/to/my/repolist.yml"

mkdocs.yml

@@ -38,7 +38,7 @@ theme:
       toggle:
         icon: material/toggle-switch
         name: Switch to light mode
-# Blog's Navigation needs to be excempt from literate nav...
+# Blog's Navigation needs to be exempt from literate nav...
 nav:
   - Home: "index.md"
   - "User Manual":

src/pulp_docs/constants.py

@@ -38,7 +38,7 @@ class Names:
     # personas
     USER = "Usage"
     ADMIN = "Administration"
-    DEV = "Developemnt"
+    DEV = "Developments"
 
     # other
     PULPCORE_TUTORIAL = "Getting Started"

src/pulp_docs/openapi.py

@@ -54,7 +54,7 @@ def get_remote_url(self):
 
 class OpenAPIGenerator:
     """
-    Responsible for seting up a python environment with the required
+    Responsible for setting up a python environment with the required
     Pulp packages to generate openapi schemas for all registered plugins.
 
     Args:
@@ -110,7 +110,7 @@ def setup_venv(self, plugin: PulpPlugin):
     def run_python(self, *cmd: str) -> str:
         """Run a binary command from within the tmp venv.
 
-        Basicaly: $tmp-venv/bin/{first-arg} {remaining-args}
+        Basically: $tmp-venv/bin/{first-arg} {remaining-args}
         """
         cmd_bin = os.path.join(self.venv_path, f"bin/{cmd[0]}")
         final_cmd = [cmd_bin] + list(cmd[1:])
@@ -141,7 +141,7 @@ def parse_args():
         "-l",
         "--plugin-list",
         type=str,
-        help="List of plugins that should be used. Use all if ommited.",
+        help="List of plugins that should be used. Use all if omitted.",
     )
     args = parser.parse_args()
 

src/pulp_docs/repository.py

@@ -32,7 +32,7 @@
 # @dataclass # raising errors in py311/312
 class RepoStatus:
     """
-    Usefull status information about a downloaded repository.
+    Useful status information about a downloaded repository.
     """
 
     def __init__(self, **kwargs):
@@ -183,7 +183,7 @@ def download_from_gh_main(dest_dir: Path, owner: str, name: str, branch: str):
     try:
         subprocess.run(cmd, check=True)
     except subprocess.CalledProcessError as e:
-        log.error(f"An error ocurred while trying to download '{name}' source-code:\n{e}")
+        log.error(f"An error occurred while trying to download '{name}' source-code:\n{e}")
         raise
 
     log.info("Done.")

src/pulp_docs/test_tools/doctree_writer.py

@@ -18,17 +18,17 @@ def parse_doctree_file(doctree_file: Path, target: Path, project_name: str = "fo
 
     ```pseudo-format
     {
-        projet-name-1: [{path: content}, ...,  {path: content}],
+        project-name-1: [{path: content}, ...,  {path: content}],
         ...
-        projet-name-N: [{path: content}, ..., {path: content}],
+        project-name-N: [{path: content}, ..., {path: content}],
     }
     ```
 
     See `test_doctree_writer` for samples.
 
     Params:
         doctree_file: The input file to be parsed. Supports `.toml` `.yml` and `.doctree`
-        target: The directory where the project should be writter to.
+        target: The directory where the project should be written to.
     """
 
     def custom_parser(file: Path):