Skip to content

Commit 246cf61

Browse files
Update README.md
Replace "command" with "function".
1 parent a7299b0 commit 246cf61

1 file changed

Lines changed: 17 additions & 17 deletions

File tree

README.md

Lines changed: 17 additions & 17 deletions
Original file line numberDiff line numberDiff line change
@@ -46,7 +46,7 @@ This Python API has 3 functions:
4646

4747
Detailed documentation is available in https://electronic-mango.github.io/simple-justwatch-python-api/.
4848

49-
Example outputs from all commands are in [`examples/`](examples/) directory.
49+
Example outputs from all functions are in [`examples/`](examples/) directory.
5050

5151

5252
### Search
@@ -83,16 +83,16 @@ Returned value is a list of [`MediaEntry`](#return-data-structures) objects.
8383

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

86-
Example command and its output is in [`examples/search_output.py`](examples/search_output.py).
86+
Example function call and its output is in [`examples/search_output.py`](examples/search_output.py).
8787

8888

8989
### Details
9090

9191
Details function allows for looking up details for a single entry via its node ID.
92-
Node ID can be taken from output of the [`search`](#search) command.
92+
Node ID can be taken from output of the [`search`](#search) function.
9393

94-
Output from this function contains the same data as a single entry from the [`search`](#search) command.
95-
There's no reason to first use the [`search`](#search) command, then use node ID from one of entries for this command.
94+
Output from this function contains the same data as a single entry from the [`search`](#search) function.
95+
There's no reason to first use the [`search`](#search) function, then use node ID from one of entries for this function.
9696

9797
```python
9898
from simplejustwatchapi.justwatch import details
@@ -109,7 +109,7 @@ Only the first argument is required - the node ID of element to look up details
109109
| 3 | `language` | `str` | NO | `"en"` | Language of responses |
110110
| 5 | `best_only` | `bool` | NO | `True` | Determines whether only best offers should be returned |
111111

112-
General usage of these arguments matches the [`search`](#search) command.
112+
General usage of these arguments matches the [`search`](#search) function.
113113

114114
Returned value is a single [`MediaEntry`](#return-data-structures) object.
115115

@@ -121,20 +121,20 @@ Some fields are specific for one of the media types and will be `None` for other
121121
- `episode_number` is present only for episodes
122122
- `age_certification` is present only for movies and shows
123123

124-
For episodes specifically most of the fields will be empty (which is why [`episodes`](#episodes) command returns different structure).
124+
For episodes specifically most of the fields will be empty (which is why [`episodes`](#episodes) function returns different structure).
125125

126-
Example command and its output is in [`examples/details_output.py`](examples/details_output.py).
126+
Example function call and its output is in [`examples/details_output.py`](examples/details_output.py).
127127

128128

129129
### Seasons
130130

131131
Seasons function allows for looking up all seasons of a show via its node ID.
132-
Node/show ID can be taken from output of the [`search`](#search) command.
133-
It's also the same ID as input for [`details`](#details) command.
132+
Node/show ID can be taken from output of the [`search`](#search) function.
133+
It's also the same ID as input for [`details`](#details) function.
134134

135-
Each season contains similar data to the [`details`](#details) command, with additional season number and number of episodes.
135+
Each season contains similar data to the [`details`](#details) function, with additional season number and number of episodes.
136136

137-
Usage also matches [`details`](#details) command:
137+
Usage also matches [`details`](#details) function:
138138
```python
139139
from simplejustwatchapi.justwatch import seasons
140140

@@ -156,9 +156,9 @@ Returned value is a list of [`MediaEntry`](#return-data-structures) objects, eac
156156
### Episodes
157157

158158
Episodes function allows for looking up all episodes of a season via season's node ID.
159-
Node/season ID can be taken from output of the [`seasons`](#seasons) command.
159+
Node/season ID can be taken from output of the [`seasons`](#seasons) function.
160160

161-
Usage matches [`details`](#details) command:
161+
Usage matches [`details`](#details) function:
162162
```python
163163
from simplejustwatchapi.justwatch import seasons
164164

@@ -200,11 +200,11 @@ First two arguments are required - node ID, and set of countries.
200200
| 3 | `language` | `str` | NO | `"en"` | Language of responses |
201201
| 5 | `best_only` | `bool` | NO | `True` | Determines whether only best offers should be returned |
202202

203-
Usage of `language` and `best_only` arguments matches the [`search`](#search) command.
203+
Usage of `language` and `best_only` arguments matches the [`search`](#search) function.
204204

205205
Returned value `dict[str, list[Offer]]`, where key is country given as argument and value is a list of [`Offer`](#return-data-structures) tuples.
206206

207-
Example command and its output is in [`examples/offers_for_countries_output.py`](examples/offers_for_countries_output.py).
207+
Example function call and its output is in [`examples/offers_for_countries_output.py`](examples/offers_for_countries_output.py).
208208

209209

210210

@@ -219,7 +219,7 @@ Some fields are specific for one of the media types and will be `None` for other
219219
- `episode_number` is present only for episodes
220220
- `age_certification` is present only for movies and shows
221221

222-
For episodes specifically most of the fields will be empty (which is why [`episodes`](#episodes) command returns different structure).
222+
For episodes specifically most of the fields will be empty (which is why [`episodes`](#episodes) function returns different structure).
223223

224224
As [`search`](#search) function can return only movies and shows the episode-specific and season-specific fields will always be `None`,
225225
but are included in `MediaEntry` so they will be present in output from [`details`](#details) function.

0 commit comments

Comments
 (0)