Tweak docs

Author: Electronic-Mango

docs/caveats.md

@@ -53,15 +53,16 @@ it doesn't seem to be comprehensive.
 
 ### Country
 
-Required pattern is two uppercase letters:
+Required pattern is two uppercase letters (e.g., `US`, `DE`, `GB`):
 ```regex
 ^[A-Z]{2}$
 ```
 
 It looks like **ISO 3166-1 alpha-2** standard.
 
-API expects only uppercase letters, however this library will automatically convert
-country codes to uppercase.
+!!! tip "Country code letter case"
+    API expects only uppercase letters, however this library will automatically convert
+    country codes to uppercase.
 
 If country code doesn't match the regex, or isn't a valid code the API will respond
 with an internal error and [`JustWatchApiError`]
@@ -70,17 +71,18 @@ with an internal error and [`JustWatchApiError`]
 
 ### Language
 
-Required pattern is 2 lowercase letters with optional alphanumeric suffix after `-`.
+Required pattern is 2 lowercase letters with optional
+alphanumeric suffix after `-` (e.g., `en`, `en-US`, `fr`, `de`, `de-CH`, `de-CH1901`).
 The sufix must be uppercase:
 ```
 ^[a-z]{2}(-[0-9A-Z]+)?$
 ```
 
-It looks like a subset of **IETF BCP 47**. The code isn't full BCP 47 as the suffix
-allows only for numbers and uppercase letters.
+It looks similar to **IETF BCP 47** standard.
 
-**The provided language isn't modified at all by this library, so it must match the
-regex exactly, including letter case.**
+!!! warning "Language code letter case"
+    The provided language isn't modified at all by this library, so it must match the
+    regex exactly, including letter case.
 
 If language code doesn't match the expected regex the API will respond with an internal
 error and [`JustWatchApiError`][simplejustwatchapi.exceptions.JustWatchApiError] will be

docs/index.md

@@ -9,25 +9,25 @@ icon: lucide/circle-play
     However, the main functionality should be (more or less) correct.
 
 A simple unofficial JustWatch Python API which uses [`GraphQL`](https://graphql.org/)
-to access JustWatch data, built with [`httpx`](https://www.python-httpx.org/) and
-Python `3.11+`.
+to access [JustWatch](https://www.justwatch.com/) data, built with
+[`httpx`](https://www.python-httpx.org/) and available for Python `3.11+`.
 
-This project is managed by [uv](https://docs.astral.sh/uv/).
+This library is published as a
+[Python package on PyPi](https://pypi.org/project/simple-justwatch-python-api/).
 
 
 
 ## Functions
 
-This library provides multiple functions for accessing JustWatch:
+This library provides multiple ways of accessing JustWatch:
 
- - `search` - search for entries based on title
- - `popular` - get a list of currently popular titles
- - `details` - get details for a title based on its ID
- - `seasons` - get information about all seasons of a show
- - `episodes` - get information about all episodes of a season
- - `offers_for_countries` - get offers for a title based on its ID for multiple
-    countries
- - `providers` - get data about all available providers (like Netflix) in a country
+ - Search for a title.
+ - Get currently popular titles.
+ - Get details of a specific entry based on ID.
+ - Get information about all seasons of a show.
+ - Get information about all episodes of a season.
+ - Get offers for a title for multiple countries.
+ - Get data about all available providers (such as Netflix) in a country.
 
 All needed functions, data structures, raised exceptions are available through single
 module `simplejustwatchapi`.

docs/usage.md

@@ -42,7 +42,7 @@ ones, like `node_id`, or `title` to search for):
 
 Functions returning data for multiple titles
 ([`search`][simplejustwatchapi.justwatch.search],
-[`details`][simplejustwatchapi.justwatch.details])
+[`popular`][simplejustwatchapi.justwatch.popular])
 also allow for specifying number of elements, basic pagination, and filtering for
 specific providers:
 

src/simplejustwatchapi/justwatch.py

@@ -101,7 +101,7 @@ def search(
     It can also contain alphanumeric (in uppercase) suffix after `-` symbol, most
     likely used for regional variants (e.g., `en-US`, `de-CH`).
     It looks like a subset of IETF BCP 47, however the suffix can contain only uppercase
-    letters and numbers. It's value isn't normalized and **must** be provided in
+    letters and numbers. Its value isn't normalized and **must** be provided in
     expected format, including letter case.
 
     Returns a list of entries up to `count`.