diff --git a/docs/api-reference/exceptions.md b/docs/api-reference/exceptions.md index c6ad7ae..9ca2775 100644 --- a/docs/api-reference/exceptions.md +++ b/docs/api-reference/exceptions.md @@ -1,4 +1,4 @@ -PyAniList doesn't raise any custom exceptions of it's own. The two most likely errors you'll encounter will be either of these: +`pyanilist` doesn't raise any custom exceptions of it's own. The two most likely errors you'll encounter will be either of these: - `pyanilist.HTTPStatusError` - Alias for [`httpx.HTTPStatusError`](https://www.python-httpx.org/exceptions/). Raised if a request returns a non 2xx status code. - `pyanilist.ValidationError` - Alias for [`pydantic.ValidationError`](https://docs.pydantic.dev/latest/errors/validation_errors/). Raised if an input is invalid. diff --git a/docs/examples.md b/docs/examples.md index 3157fdc..d48d1da 100644 --- a/docs/examples.md +++ b/docs/examples.md @@ -33,6 +33,7 @@ print(media.episodes) ```py from pyanilist import AniList, MediaSeason, MediaType, MediaStatus, MediaFormat + media = AniList().get( "My Hero Academia", season=MediaSeason.SPRING, @@ -42,6 +43,7 @@ media = AniList().get( status=MediaStatus.FINISHED, ) + print(media.title.romaji) #> Boku no Hero Academia print(media.start_date.iso_format()) @@ -89,7 +91,7 @@ print(main_characters) ## Retries -AniList API is flaky, sometimes it might return an error for a perfectly valid request. `pyanilist` handles this by simply retrying failed requests a specified number of times (default is 5) before raising an error. Every subsequent retry also adds an additional delay between requests. +AniList API is flaky, sometimes it might return an error for a perfectly valid request. `pyanilist` handles this by simply retrying failed requests a specified number of times (default is 5) before raising an error. ```py from pyanilist import AniList