Skip to content

Commit 204db1d

Browse files
Add note to README.md regarding when "details" is useful
1 parent afd4e4c commit 204db1d

1 file changed

Lines changed: 5 additions & 1 deletion

File tree

README.md

Lines changed: 5 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -92,8 +92,12 @@ Details function allows for looking up details for a single entry via its node I
9292
Node ID can be taken from output of the [`search`](#search) function.
9393

9494
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.
9695

96+
> **In general using this function is only useful if you have node ID already stored.**
97+
There's no reason to first use the [`search`](#search) function, then use node ID from one of entries for `details`, you won't get any additional information.
98+
If you want to get seasons/episodes you can use the ID from [`search`](#search) function to call [`seasons`](#seasons), and then [`episodes`](#episodes). Calling `details` on an individual season/episode won't give you more information than outputs from the dedicated commands.
99+
100+
Usage is similar to [`search`](#search) function, just without `count` argument:
97101
```python
98102
from simplejustwatchapi.justwatch import details
99103

0 commit comments

Comments
 (0)