docs: fix some typos (#323)

jeis4wpi · web-flow · commit 5c8731a5e8eb · 2026-05-23T22:46:25.000+02:00
Signed-off-by: John E &lt;jeis4wpi@outlook.com&gt;
diff --git a/api/src/anipy_api/locallist.py b/api/src/anipy_api/locallist.py
@@ -148,7 +148,7 @@ def update(
             if not ("episode" in update_fields and "language" in update_fields):
                 raise ArgumentError(
                     "The anime you are trying to update is not added to the list and you are not"
-                    "providing the neccessary update_fields `episode` and `language`, this can not be processed"
+                    "providing the necessary update_fields `episode` and `language`, this can not be processed"
                 )
 
             entry = LocalListEntry(
diff --git a/api/src/anipy_api/provider/base.py b/api/src/anipy_api/provider/base.py
@@ -140,7 +140,7 @@ def __init_subclass__(cls) -> None:
         for v in ["NAME", "BASE_URL", "FILTER_CAPS"]:
             if not hasattr(cls, v):
                 raise NotImplementedError(
-                    "Attribute '{}' has not been overriden in class '{}'".format(
+                    "Attribute '{}' has not been overridden in class '{}'".format(
                         v, cls.__name__
                     )
                 )
diff --git a/cli/src/anipy_cli/cli.py b/cli/src/anipy_cli/cli.py
@@ -42,7 +42,7 @@ def _safe_cli(args: CliArgs):
     config._create_config()
 
     if config.dc_presence:
-        with DotSpinner("Intializing Discord Presence...") as s:
+        with DotSpinner("Initializing Discord Presence...") as s:
             try:
                 DiscordPresence()
                 s.set_text(colors.GREEN, "Initialized Discord Presence")
diff --git a/cli/src/anipy_cli/menus/anilist_menu.py b/cli/src/anipy_cli/menus/anilist_menu.py
@@ -196,15 +196,15 @@ def tag_anime(self):
             choices.append(
                 Choice(
                     value=config.tracker_dub_tag,
-                    name=f"{config.tracker_dub_tag} (sets wheter you prefer to watch a particular anime in dub)",
+                    name=f"{config.tracker_dub_tag} (sets whether you prefer to watch a particular anime in dub)",
                 )
             )
 
         if config.tracker_ignore_tag:
             choices.append(
                 Choice(
                     value=config.tracker_ignore_tag,
-                    name=f"{config.tracker_ignore_tag} (sets wheter anipy-cli will ignore a particular anime)",
+                    name=f"{config.tracker_ignore_tag} (sets whether anipy-cli will ignore a particular anime)",
                 )
             )
 
diff --git a/cli/src/anipy_cli/menus/mal_menu.py b/cli/src/anipy_cli/menus/mal_menu.py
@@ -193,15 +193,15 @@ def tag_anime(self):
             choices.append(
                 Choice(
                     value=config.tracker_dub_tag,
-                    name=f"{config.tracker_dub_tag} (sets wheter you prefer to watch a particular anime in dub)",
+                    name=f"{config.tracker_dub_tag} (sets whether you prefer to watch a particular anime in dub)",
                 )
             )
 
         if config.tracker_ignore_tag:
             choices.append(
                 Choice(
                     value=config.tracker_ignore_tag,
-                    name=f"{config.tracker_ignore_tag} (sets wheter anipy-cli will ignore a particular anime)",
+                    name=f"{config.tracker_ignore_tag} (sets whether anipy-cli will ignore a particular anime)",
                 )
             )
 
diff --git a/cli/src/anipy_cli/prompts.py b/cli/src/anipy_cli/prompts.py
@@ -377,7 +377,7 @@ def migrate_provider(mode: str, local_list: "LocalList"):
         if best_ratio >= config.mal_mapping_min_similarity:
             local_list.delete(s)
         else:
-            print(f"Could not autmatically map {s.name}, you can map it manually.")
+            print(f"Could not automatically map {s.name}, you can map it manually.")
             best_anime = search_show_prompt("seasonal", skip_season_search=True)
             if best_anime is None:
                 continue
diff --git a/cli/src/anipy_cli/util.py b/cli/src/anipy_cli/util.py
@@ -254,11 +254,11 @@ def convert_letter_to_season(letter: str) -> Optional[str]:
 
 
 def migrate_locallist(file: Path) -> LocalListData:
-    error(f"{file} is in an unsuported format...")
+    error(f"{file} is in an unsupported format...")
 
     new_list = LocalListData({})
     choice = inquirer.confirm(  # type: ignore
-        message="Should it be delted?",
+        message="Should it be deleted?",
         default=False,
     ).execute()
     if choice:
diff --git a/docs/contributing/index.md b/docs/contributing/index.md
@@ -5,17 +5,17 @@ Hey, thanks for considering to contribute!
 If you did this before you probably know the gist, but check out this little guide to get everything set-up!
 
 ## Setup environment for code/docs changes
-1. Install [Poetry](https://python-poetry.org/docs/#installation) for project managment, it is like pip but better and feature-richer. You can work on this project without it, but I highly recommend not to do this.
+1. Install [Poetry](https://python-poetry.org/docs/#installation) for project management, it is like pip but better and feature-richer. You can work on this project without it, but I highly recommend not to do this.
 2. Clone: `git clone https://github.com/sdaqo/anipy-cli && cd anipy-cli`
 3. Initiate your environment: `poetry install --with dev,docs`, this installs all the dependencies and some development tools.
 4. (Optional) If you are working on the API and you want to be able to test your changes in the cli, you can run `poetry run poe enter-dev`. (this changes the api dependency to the local `../api`)
-5. Open your edior, you can either run `poetry run <your-editor>` or `poetry shell` to get a shell in the virtual environment and run your editor from there, some editors like vscode automatically enter the venv as far as I know.
+5. Open your editor, you can either run `poetry run <your-editor>` or `poetry shell` to get a shell in the virtual environment and run your editor from there, some editors like vscode automatically enter the venv as far as I know.
 6. Make your changes :)
 7. Check your changes
     - Run `poetry run anipy-cli` to run the cli.
     - Run `poetry run python` to run python from the virtual environment.
     - Run `poetry run poe docs-serve` to open host the docs locally, this is helpful if you are making changes to the docs.
-8. Run `poetry run poe polish` before commiting to format and lint your code. The linter will tell you what you did wrong, fix that if you think the suggestion from the linter is reasonable, if not don't bother. Also, please do not concern yourself with linter errors that you did not introduce!
+8. Run `poetry run poe polish` before committing to format and lint your code. The linter will tell you what you did wrong, fix that if you think the suggestion from the linter is reasonable, if not don't bother. Also, please do not concern yourself with linter errors that you did not introduce!
 9. Run `poetry run poe exit-dev` if you ran the command in step 4.
 10. Push & Pull Request!
 
@@ -24,11 +24,11 @@ If you did this before you probably know the gist, but check out this little gui
 .
 ├── api
 │   ├── pyproject.toml # spec file for api
-│   └── src 
+│   └── src
 │       └── anipy_api # api source
 ├── cli
 │   ├── pyproject.toml # spec file for cli
-│   └── src 
+│   └── src
 │       └── anipy_cli # cli source
 ├── docs # documentation
 │   └── ...
diff --git a/docs/getting-started-api/examples/myanimelist.md b/docs/getting-started-api/examples/myanimelist.md
@@ -4,10 +4,10 @@ Uhm, I did not find a proper implementation of the MyAnimeList v2 api for
 python... so yeah.
 
 There is also support for [anilist](https://anilist.co/), the usage is generally the same,
-exepect for authentication. 
-For the API docs please see [AniList][anipy_api.anilist.AniList] and [AniListAdapter][anipy_api.anilist.AniListAdapter] 
+exepect for authentication.
+For the API docs please see [AniList][anipy_api.anilist.AniList] and [AniListAdapter][anipy_api.anilist.AniListAdapter]
 also check [anilist_cli.py](https://github.com/sdaqo/anipy-cli/blob/master/cli/src/anipy_cli/clis/anilist_cli.py) for a implementation example.
-    
+
 ## Authentication
 
 The [MyAnimeList][anipy_api.mal.MyAnimeList] class implement basic
@@ -32,7 +32,7 @@ mal = MyAnimeList.from_rt_grant(
 1. Those functions may throw a
    [MyAnimeListError][anipy_api.error.MyAnimeListError] when auth fails, wrap
    them in a try/except.
-2. Please note that that currently no complex oauth autentication scheme is
+2. Please note that that currently no complex oauth authentication scheme is
    implemented, this client uses the client id of the official MyAnimeList
    android app, this gives us the ability to login via a username/password
    combination. If you pass your own client id you will not be able to use the
@@ -98,10 +98,10 @@ add that to your myanimelist, but you do not know which mal anime that is. The
 [MyAnimeListAdapter][anipy_api.mal.MyAnimeListAdapter] class can handle that for
 you.
 
-BUT this does not always work, there is a possibilty that the adapter can not
+BUT this does not always work, there is a possibility that the adapter can not
 match the anime, this class uses the
 [Levenshtein Distance](https://en.wikipedia.org/wiki/Levenshtein_distance)
-algorithm to calculate the similiarty between names, you can tweak its
+algorithm to calculate the similarity between names, you can tweak its
 parameters and also other stuff to ensure you get a match.
 
 ```python
@@ -136,7 +136,7 @@ if anime is not None:
 
 1. The provider to or from which you want to adapt.
 2. The minimum accepted similarity ratio. This should be a number from 0-1, 1
-   meaning the names are identical 0 meaning there are no identical charachters
+   meaning the names are identical 0 meaning there are no identical characters
    whatsoever. If it is not met the function will return None.
 3. With this the alternative names will also be checked if available. This
    improves chances of matching but may take longer.
diff --git a/docs/getting-started-api/examples/player.md b/docs/getting-started-api/examples/player.md
@@ -32,8 +32,8 @@ mpv_player.play_file("/some/file.mp4") # (2)
 1. You can also use the [list_players][anipy_api.player.player.list_players] function to get a list of players.
 2. With the [play_file][anipy_api.player.base.PlayerBase.play_file] function you can play local files.
 
-You can also use the mpv-controllable player, it wraps the [python-mpv](https://github.com/jaseg/python-mpv?tab=readme-ov-file#usage) 
-player which uses libmpv, check python-mpv's readme to know how to get libmpv. This allows you to controll the player in the code, check this out:
+You can also use the mpv-controllable player, it wraps the [python-mpv](https://github.com/jaseg/python-mpv?tab=readme-ov-file#usage)
+player which uses libmpv, check python-mpv's readme to know how to get libmpv. This allows you to control the player in the code, check this out:
 ```python
 from anipy_api.player import get_player, list_players
 from anipy_api.anime import Anime
@@ -44,7 +44,7 @@ def on_play(anime: Anime, stream: ProviderStream):
 
 mpv_controllable_player = get_player(
     "mpv-controllable",
-    play_callback=on_play 
+    play_callback=on_play
     # (1)
 )
 
diff --git a/docs/getting-started-api/examples/provider.md b/docs/getting-started-api/examples/provider.md
@@ -1,13 +1,13 @@
 ## What is a provider?
-A provider in anipy-api is the building stone that connects us to the anime we want! A provder may be a external anime site or even your local files (this is planned, Coming Soon!). Every provider bases on the [BaseProvider][anipy_api.provider.base.BaseProvider] and has the same basic functions: `get_search`, `get_episodes`, `get_info` and `get_video`.
+A provider in anipy-api is the building stone that connects us to the anime we want! A provider may be a external anime site or even your local files (this is planned, Coming Soon!). Every provider bases on the [BaseProvider][anipy_api.provider.base.BaseProvider] and has the same basic functions: `get_search`, `get_episodes`, `get_info` and `get_video`.
 
 You can check which providers anipy-cli supports [here](../../availabilty.md) or [here][anipy_api.provider.provider] (in the `providers` drop-down).
 
 ## Getting a provider instance
 To get a provider you can use the [list_providers][anipy_api.provider.provider.list_providers] function, [get_provider][anipy_api.provider.provider.get_provider] to get a provider by its string representation or just simply import it directly.
 
 ```python
-from anipy_api.provider import list_providers, get_provider 
+from anipy_api.provider import list_providers, get_provider
 
 
 # List providers
@@ -56,14 +56,14 @@ if provider.FILTER_CAPS & ( # (1)
     fall_2023_anime = provider.get_search("", filters=filters) # (4)
 ```
 
-1. You can use bitwise operators here because this is a Flag class, check out the offical [documentation](https://docs.python.org/3/library/enum.html#enum.Flag), you may also use the `in` keyword.
+1. You can use bitwise operators here because this is a Flag class, check out the official [documentation](https://docs.python.org/3/library/enum.html#enum.Flag), you may also use the `in` keyword.
 2. If a provider supports NO_QUERY it means that if you search without query you get all available anime in its database.
 3. If you use filters not supported by the provider, they will get skipped, no error will be raised.
 4. Here we search without query, because we want to get all the anime available that are in the fall season of 2023.
 
 ## Putting it all together
 ```python
-from anipy_api.provider import get_provider 
+from anipy_api.provider import get_provider
 
 provider = get_provider("allanime")
 frieren = provider.get_search("frieren")[0]
@@ -80,7 +80,7 @@ if provider.FILTER_CAPS & (
     fall_2023_anime = provider.get_search("", filters=filters)
 
     if frieren in fall_2023_anime:
-        print("Frieren is an fall 2023 anime!") 
+        print("Frieren is an fall 2023 anime!")
 ```
 
 ## Thats about it here
diff --git a/docs/getting-started-cli/index.md b/docs/getting-started-cli/index.md
@@ -14,14 +14,14 @@
     ```
     # Install
     pipx install anipy-cli
-    
+
     # Update
     pipx upgrade anipy-cli
-    
+
     # Uninstall
     pipx uninstall anipy-cli
     ```
-- Via pipx (from source): 
+- Via pipx (from source):
 ```
 # Install
 pipx install "git+https://github.com/sdaqo/anipy-cli.git#subdirectory=cli"
@@ -32,7 +32,7 @@ pipx upgrade anipy-cli
 # Uninstall
 pipx uninstall anipy-cli
 ```
-- Via pip: 
+- Via pip:
 ```
 # Install
 pip install anipy-cli
@@ -43,7 +43,7 @@ pip --upgrade anipy-cli
 # Uninstall
 pip uninstall anipy-cli
 ```
-- Via pip (from source): 
+- Via pip (from source):
 ```
 # Install
 pip install "git+https://github.com/sdaqo/anipy-cli.git#subdirectory=cli"
@@ -54,15 +54,15 @@ pip --upgrade anipy-cli
 # Uninstall
 pip uninstall anipy-cli
 ```
-- NixOS: 
+- NixOS:
 ```
 # Make sure you have flakes enabled on your system!
 
 # Just run it once to try the program
 nix run github:sdaqo/anipy-cli
 
 # Add them to your flake inputs (recommended)
-# 
+#
 # {
 #   anipy-cli.url = "github:sdaqo/anipy-cli";
 # }
@@ -83,7 +83,7 @@ nix profile remove <index-of-anipy-cli>
 
 ## Usage
 
-=== "Explainations for non-obvious stuff"
+=== "Explanations for non-obvious stuff"
 
     ### Seasonal Mode
     Seasonal Mode is one of the major modes of anipy-cli, with it you can
@@ -161,7 +161,7 @@ nix profile remove <index-of-anipy-cli>
 
     ### Auto Update
     Auto update is a flag in anipy-cli: `--auto-update` it will automatically update and download all anime in seasonals or mal mode from start
-    episode to newest. This is increadibly handy if you want to set up some [cron job](https://de.wikipedia.org/wiki/Cron) to keep your library up-to-date.
+    episode to newest. This is incredibly handy if you want to set up some [cron job](https://de.wikipedia.org/wiki/Cron) to keep your library up-to-date.
 
     !!! note
         This only works in combination with `-M` or `-S`
@@ -189,10 +189,10 @@ nix profile remove <index-of-anipy-cli>
     This is just a paste from `anipy-cli --help`.
     ```
     usage: anipy-cli [-D | -B | -H | -S | -M | -A | --delete-history | --migrate-history]
-                     [-s SEARCH] [-ss [SEASONAL_SEARCH]] [-q QUALITY] [-f] [-a] 
+                     [-s SEARCH] [-ss [SEASONAL_SEARCH]] [-q QUALITY] [-f] [-a]
                      [-p {mpv,vlc,iina,syncplay,mpvnet,mpv-controlled}] [-l LOCATION]
-                     [-V] [--stack-always] [-so] [--mal-password MAL_PASSWORD] 
-                     [--mal-user MAL_USER] [--mal-sync-to-seasonals] 
+                     [-V] [--stack-always] [-so] [--mal-password MAL_PASSWORD]
+                     [--mal-user MAL_USER] [--mal-sync-to-seasonals]
                      [--anilist-sync-to-seasonals] [-h] [-v] [--config-path]
 
     Play Animes from online anime providers locally or download them, and much more.

Original file line number	Diff line number	Diff line change
`@@ -148,7 +148,7 @@ def update(`
`148`	`148`	`if not ("episode" in update_fields and "language" in update_fields):`
`149`	`149`	`raise ArgumentError(`
`150`	`150`	`"The anime you are trying to update is not added to the list and you are not"`
`151`		- "providing the neccessary update_fields `episode` and `language`, this can not be processed"
	`151`	+ "providing the necessary update_fields `episode` and `language`, this can not be processed"
`152`	`152`	`)`
`153`	`153`
`154`	`154`	`entry = LocalListEntry(`
Original file line number	Diff line number	Diff line change
`@@ -140,7 +140,7 @@ def __init_subclass__(cls) -> None:`
`140`	`140`	`for v in ["NAME", "BASE_URL", "FILTER_CAPS"]:`
`141`	`141`	`if not hasattr(cls, v):`
`142`	`142`	`raise NotImplementedError(`
`143`		`- "Attribute '{}' has not been overriden in class '{}'".format(`
	`143`	`+ "Attribute '{}' has not been overridden in class '{}'".format(`
`144`	`144`	`v, cls.__name__`
`145`	`145`	`)`
`146`	`146`	`)`
Original file line number	Diff line number	Diff line change
`@@ -196,15 +196,15 @@ def tag_anime(self):`
`196`	`196`	`choices.append(`
`197`	`197`	`Choice(`
`198`	`198`	`value=config.tracker_dub_tag,`
`199`		`- name=f"{config.tracker_dub_tag} (sets wheter you prefer to watch a particular anime in dub)",`
	`199`	`+ name=f"{config.tracker_dub_tag} (sets whether you prefer to watch a particular anime in dub)",`
`200`	`200`	`)`
`201`	`201`	`)`
`202`	`202`
`203`	`203`	`if config.tracker_ignore_tag:`
`204`	`204`	`choices.append(`
`205`	`205`	`Choice(`
`206`	`206`	`value=config.tracker_ignore_tag,`
`207`		`- name=f"{config.tracker_ignore_tag} (sets wheter anipy-cli will ignore a particular anime)",`
	`207`	`+ name=f"{config.tracker_ignore_tag} (sets whether anipy-cli will ignore a particular anime)",`
`208`	`208`	`)`
`209`	`209`	`)`
`210`	`210`
Original file line number	Diff line number	Diff line change
`@@ -193,15 +193,15 @@ def tag_anime(self):`
`193`	`193`	`choices.append(`
`194`	`194`	`Choice(`
`195`	`195`	`value=config.tracker_dub_tag,`
`196`		`- name=f"{config.tracker_dub_tag} (sets wheter you prefer to watch a particular anime in dub)",`
	`196`	`+ name=f"{config.tracker_dub_tag} (sets whether you prefer to watch a particular anime in dub)",`
`197`	`197`	`)`
`198`	`198`	`)`
`199`	`199`
`200`	`200`	`if config.tracker_ignore_tag:`
`201`	`201`	`choices.append(`
`202`	`202`	`Choice(`
`203`	`203`	`value=config.tracker_ignore_tag,`
`204`		`- name=f"{config.tracker_ignore_tag} (sets wheter anipy-cli will ignore a particular anime)",`
	`204`	`+ name=f"{config.tracker_ignore_tag} (sets whether anipy-cli will ignore a particular anime)",`
`205`	`205`	`)`
`206`	`206`	`)`
`207`	`207`