Skip to content

Commit 6e4eb72

Browse files
Final docs pages tweaks
1 parent b62a18b commit 6e4eb72

3 files changed

Lines changed: 14 additions & 13 deletions

File tree

docs/caveats.md

Lines changed: 9 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -91,12 +91,12 @@ error and [`JustWatchApiError`][simplejustwatchapi.exceptions.JustWatchApiError]
9191
raised.
9292

9393
If the code **does** match the regex, but isn't a valid code, then the API defaults to
94-
english and no exception is raised.
94+
English and no exception is raised.
9595

9696
!!! note "Discrepancy between invalid country and language codes"
9797
API handles codes matching expected pattern, but still not valid differently between
9898
country and language - for country API will return and error, thus exception will
99-
be raised; while for language it will default to english.
99+
be raised; while for language it will default to English.
100100

101101

102102

@@ -128,8 +128,9 @@ The JustWatch API itself won't allow for getting more than 1999 entries, through
128128
and `offset`, regardless of operation complexity. If you try to get the 2000th entry,
129129
the API (and functions in this libary) will return an empty list.
130130

131-
**If you try to access over the 1999th entry you won't get *up to* 1999 entries,
132-
you'll get an empty list.**
131+
!!! warning "Entries *up to* 1999th"
132+
If you try to access over the 1999th entry you won't get *up to* 1999 entries,
133+
you'll get an empty list.
133134

134135
For example, this will get you entries 1990 - 1999 - a 9 element list of [`MediaEntry`]
135136
[simplejustwatchapi.tuples.MediaEntry],
@@ -209,10 +210,10 @@ Unfortunately, I don't know of any way around the issue with
209210
than 1999 elements.
210211

211212
!!! note "Stability of results with pagination"
212-
All "pagination" is done on the side of the API, by offsetting which is the first
213-
element, nothing is done on the side of this library. Since this operation isn't
214-
keeping any context between requests there's no guarantee of "stability" of results
215-
between requests - whether titles will shift order while you're getting pages.
213+
All "pagination" is done on the side of the API by offsetting which is the first
214+
element. Since this operation isn't keeping any context between requests there's no
215+
guarantee of "stability" of results between requests - whether titles will shift
216+
order while you're getting pages.
216217

217218

218219

docs/index.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
---
2-
icon: lucide/circle-play
2+
icon: lucide/tv-minimal-play
33
---
44

55
# Simple JustWatch Python API

docs/usage.md

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -52,7 +52,7 @@ ones, like `title` to search for):
5252
|-------------|-------------|
5353
| `country` | 2-letter country code for which offers will be returned, e.g., `US`, `GB`, `DE`. |
5454
| `language` | Code for language in responses. It consists of 2 lowercase letters with optional uppercase alphanumeric suffix (e.g., `en`, `en-US`, `de`, `de-CH1901`). |
55-
| `best_only` | Whether to return only "best" offers for each provider instead of, e.g., separate offer for SD, HD, and 4K. |
55+
| `best_only` | Whether to return only "best" offers for each provider instead of, e.g., separate offers for SD, HD, and 4K. |
5656

5757
Functions returning data for multiple titles
5858
([`search`][simplejustwatchapi.justwatch.search],
@@ -331,7 +331,7 @@ from simplejustwatchapi import search, JustWatchApiError
331331

332332
try:
333333
# Language code "xx" also isn't valid for any languages, but since it matches the
334-
# pattern it would default to english.
334+
# pattern it would default to English.
335335
results = search("The Matrix", language="xxx")
336336
except JustWatchApiError as e:
337337
# Print only error codes.
@@ -495,7 +495,7 @@ while results := popular(count=page, offset=i):
495495
```
496496

497497
!!! note "Maximum number of responses"
498-
There is a limit of number of entries you can get from the JustWatch API using this
499-
method of **1999**. Check
498+
**1999** is the limit of number of entries you can get from the JustWatch API using
499+
this method. Check
500500
[Maximum number of entries](caveats.md#maximum-number-of-entries) page for more
501501
details.

0 commit comments

Comments
 (0)