Skip to content

Commit 866c922

Browse files
Rename "request/response complexity" with "operation complexity" in README.md
1 parent 468fc49 commit 866c922

1 file changed

Lines changed: 9 additions & 9 deletions

File tree

README.md

Lines changed: 9 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -27,7 +27,7 @@ This project is managed by [uv](https://docs.astral.sh/uv/).
2727
- [Providers](#providers)
2828
- [Data structures](#data-structures)
2929
- [Locale, language, country](#locale-language-country)
30-
- [Request complexity](#request-complexity)
30+
- [Operation complexity](#operation-complexity)
3131
- [Maximum number of entries](#maximum-number-of-entries)
3232
- [Provider codes](#provider-codes)
3333
- [`providers` function](#providers-function)
@@ -102,7 +102,7 @@ If JustWatch GraphQL API returns fewer entries, then this function will also ret
102102
`best_only` determines whether similar offers, but lower quality should be included in response.
103103
If a platform offers streaming for a given entry in 4K, HD and SD, then `best_only = True` will return only the 4K offer, `best_only = False` will return all three.
104104

105-
`offset` allows for very basic pagination, letting you get more data without running into [request complexity](#request-complexity).
105+
`offset` allows for very basic pagination, letting you get more data without running into [operation complexity](#operation-complexity).
106106
It simply skips `offset` number of first entries (on the API side, nothing is done inside the library).
107107
Since there is no session there's no guarantee of results "stability" - if JustWatch decides to
108108
shuffle returned values (I'm not sure what would be the reason, but in theory it's possible)
@@ -117,7 +117,7 @@ or check [Provider codes](#provider-codes) for more details.
117117

118118
Returned value is a list of [`MediaEntry`](#return-data-structures) objects.
119119

120-
For very large searches (high `count` value) I recommend using default `best_only=True` to avoid issues with [request complexity](#request-complexity).
120+
For very large searches (high `count` value) I recommend using default `best_only=True` to avoid issues with [operation complexity](#operation-complexity).
121121

122122
Example function call and its output is in [`examples/search_output.py`](examples/search_output.py).
123123

@@ -154,7 +154,7 @@ If JustWatch GraphQL API returns fewer entries, then this function will also ret
154154
`best_only` determines whether similar offers, but lower quality should be included in response.
155155
If a platform offers streaming for a given entry in 4K, HD and SD, then `best_only = True` will return only the 4K offer, `best_only = False` will return all three.
156156

157-
`offset` allows for very basic pagination letting you get more data without running into [request complexity](#request-complexity).
157+
`offset` allows for very basic pagination letting you get more data without running into [operation complexity](#operation-complexity).
158158
It simply skips first entries (on the API side, nothing is done inside the library).
159159
Since there is no session there's no guarantee of results "stability" - if JustWatch decides to
160160
shuffle returned values (I'm not sure what would be the reason, but in theory it's possible)
@@ -169,7 +169,7 @@ or check [Provider codes](#provider-codes) for more details.
169169

170170
Returned value is a list of [`MediaEntry`](#return-data-structures) objects.
171171

172-
For very large searches (high `count` value) I recommend using default `best_only=True` to avoid issues with [request complexity](#request-complexity).
172+
For very large searches (high `count` value) I recommend using default `best_only=True` to avoid issues with [operation complexity](#operation-complexity).
173173

174174
Example function call and its output is in [`examples/popular_output.py`](examples/popular_output.py).
175175

@@ -357,9 +357,9 @@ Any combination of those languages and countries should work with this API as we
357357

358358

359359

360-
## Request complexity
360+
## Operation complexity
361361

362-
JustWatch API will respond with error on too high request/response complexity - essentially when returned graph would be too large.
362+
JustWatch API will respond with error on too high operation complexity - essentially when returned graph would be too large.
363363
It's the reason for why seasons/episodes data isn't available directly in [`search`](#search), or [`details`](#details) function
364364
(mostly the former).
365365

@@ -373,7 +373,7 @@ Using `best_only=True` should alleviate the issue somewhat, so for very large re
373373

374374
## Maximum number of entries
375375

376-
The JustWatch API itself won't allow for getting more than 1999 entries, through `count` and `offset`, regardless of request complexity.
376+
The JustWatch API itself won't allow for getting more than 1999 entries, through `count` and `offset`, regardless of operation complexity.
377377
If you try to get the 2000th entry the API (and functions in this libary) will return an empty list.
378378

379379
**If you try to access over the 1999th entry you won't get *up to* 1999 entries, you'll get an empty list.**
@@ -405,7 +405,7 @@ results = search("title", count=100, offset=1950)
405405
# len(results) == 0, API responded with empty list
406406
```
407407

408-
Interestingly, you'll still hit [too high request complexity](#request-complexity)
408+
Interestingly, you'll still hit [too high operation complexity](#operation-complexity)
409409
for too high values of `count`, even though you'd get an empty list anyway:
410410

411411
```python

0 commit comments

Comments
 (0)