Skip to content

Commit 1da9320

Browse files
Add instant preview to selected links
1 parent 669f6d0 commit 1da9320

1 file changed

Lines changed: 20 additions & 27 deletions

File tree

docs/usage.md

Lines changed: 20 additions & 27 deletions
Original file line numberDiff line numberDiff line change
@@ -55,18 +55,11 @@ specific providers:
5555
| `offset` | Basic "pagination". Offset for the first returned result, i.e. how many first entries should be skipped. Everything is handled on API side, this library isn't doing any filtering. |
5656
| `providers` | Providers (like Netflix, Amazon Prime Video) for which offers should returned. Requires 3-letter "short name". Check [Provider codes](caveats.md#provider-codes) page for an example of how you can get that value.
5757

58-
Each function can raise two exceptions:
59-
60-
| Exception | Cause |
61-
|-----------|-------|
62-
| [`JustWatchHttpError`][simplejustwatchapi.exceptions.JustWatchHttpError] | JustWatch API responded with non-`2xx` code. |
63-
| [`JustWatchApiError`][simplejustwatchapi.exceptions.JustWatchApiError] | JSON response from JustWatch API contains errors (e.g., due to invalid language or country code). If this exception is raised, then API responded with `2xx` code. |
64-
6558

6659
### Search for a title
6760

68-
[`search`][simplejustwatchapi.justwatch.search] function allows for searching entries
69-
based on a given title.
61+
[`search`][simplejustwatchapi.justwatch.search]{data-preview} function allows for
62+
searching entries based on a given title.
7063

7164
```python
7265
from simplejustwatchapi import search
@@ -98,8 +91,8 @@ Example function call and its output is in
9891

9992
### Popular titles
10093

101-
[`popular`][simplejustwatchapi.justwatch.popular] function allows for getting a list of
102-
currently popular titles.
94+
[`popular`][simplejustwatchapi.justwatch.popular]{data-preview} function allows for
95+
getting a list of currently popular titles.
10396

10497
```python
10598
from simplejustwatchapi import popular
@@ -128,8 +121,8 @@ Example function call and its output is in
128121

129122
### Details for a title based on its ID
130123

131-
[`details`][simplejustwatchapi.justwatch.details] function allows for looking up details
132-
for a single entry via its node ID.
124+
[`details`][simplejustwatchapi.justwatch.details]{data-preview} function allows for
125+
looking up details for a single entry via its node ID.
133126

134127
```python
135128
from simplejustwatchapi import details
@@ -168,8 +161,8 @@ Example function call and its output is in
168161

169162
### Details for all seasons of a TV show
170163

171-
[`seasons`][simplejustwatchapi.justwatch.seasons] function allows for looking up details
172-
for all seasons of a TV show based on its node ID.
164+
[`seasons`][simplejustwatchapi.justwatch.seasons]{data-preview} function allows for
165+
looking up details for all seasons of a TV show based on its node ID.
173166

174167
```python
175168
from simplejustwatchapi import seasons
@@ -189,8 +182,8 @@ Example function call and its output is in
189182

190183
### Details for all episodes of a TV show
191184

192-
[`episodes`][simplejustwatchapi.justwatch.episodes] function allows for looking up
193-
details for all episodes of a single TV show season based on its node ID.
185+
[`episodes`][simplejustwatchapi.justwatch.episodes]{data-preview} function allows for
186+
looking up details for all episodes of a single TV show season based on its node ID.
194187

195188
```python
196189
from simplejustwatchapi import episodes
@@ -215,9 +208,9 @@ Example function call and its output is in
215208

216209
### Get offers for multiple countries for a single title
217210

218-
[`offers_for_countries`][simplejustwatchapi.justwatch.offers_for_countries] function
219-
allows for looking up offers for a single entry, but for multiple countries at once.
220-
Only offers are returned, not additional data.
211+
[`offers_for_countries`][simplejustwatchapi.justwatch.offers_for_countries]{data-preview}
212+
function allows for looking up offers for a single entry, but for multiple countries at
213+
once. Only offers are returned.
221214

222215
```python
223216
from simplejustwatchapi import offers_for_countries
@@ -238,9 +231,9 @@ Example function call and its output is in
238231

239232
### Get all available providers for a country
240233

241-
[`providers`][simplejustwatchapi.justwatch.providers] function allows for looking up
242-
all available service providers (such as "Netflix", "Amazon Prime Video", etc.) for a
243-
given country.
234+
[`providers`][simplejustwatchapi.justwatch.providers]{data-preview} function allows for
235+
looking up all available service providers (such as "Netflix", "Amazon Prime Video",
236+
etc.) for a given country.
244237

245238
```python
246239
from simplejustwatchapi import providers
@@ -274,10 +267,10 @@ Example function call and its output is in
274267

275268
Each function can raise two exceptions:
276269

277-
| Exception | Cause |
278-
|--------------------------------------------------------------------------|-------|
279-
| [`JustWatchHttpError`][simplejustwatchapi.exceptions.JustWatchHttpError] | JustWatch API responded with non-`2xx` code. |
280-
| [`JustWatchApiError`][simplejustwatchapi.exceptions.JustWatchApiError] | JSON response from JustWatch API contains errors,<br>even though the API responded with a `2xx` status code. |
270+
| Exception | Cause |
271+
|----------------------------------------------------------------------------------------|-------|
272+
| [`JustWatchHttpError`][simplejustwatchapi.exceptions.JustWatchHttpError]{data-preview} | JustWatch API responded with non-`2xx` code. |
273+
| [`JustWatchApiError`][simplejustwatchapi.exceptions.JustWatchApiError]{data-preview} | JSON response from JustWatch API contains errors,<br>even though the API responded with a `2xx` status code. |
281274

282275
You can check [Exceptions](API Reference/exceptions.md) page for more details.
283276

0 commit comments

Comments
 (0)