Skip to content

Commit 06fff53

Browse files
committed
improve docs
1 parent 7de6f4b commit 06fff53

File tree

2 files changed

+7
-7
lines changed

2 files changed

+7
-7
lines changed

README.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -15,7 +15,7 @@ pip3 install scrapetube
1515
```
1616

1717
# Usage
18-
Here a few short code examples.
18+
Here's a few short code examples.
1919

2020
## Get all videos for a channel
2121
```python

scrapetube/scrapetube.py

+6-6
Original file line numberDiff line numberDiff line change
@@ -23,9 +23,9 @@ def get_channel(
2323
Since there is a few type's of channel url's, you can use the one you want
2424
by passing it here instead of using ``channel_id``.
2525
limit (``int``, *optional*):
26-
Limit to number of videos you want to get.
26+
Limit the number of videos you want to get.
2727
sleep (``int``, *optional*):
28-
Time to sleep between api calls to youtube in order to prevent getting blocked. Defaults to `1`.
28+
Seconds to sleep between API calls to youtube, in order to prevent getting blocked. Defaults to ``1``.
2929
sort_by (``str``, *optional*):
3030
In what order to retrive to videos. Pass one of the following values.
3131
``"newest"``: Get the new videos first.
@@ -56,9 +56,9 @@ def get_playlist(playlist_id: str, limit: int = None, sleep: int = 1) -> Generat
5656
playlist_id (``str``):
5757
The playlist id from the playlist you want to get the videos for.
5858
limit (``int``, *optional*):
59-
Limit to number of videos you want to get.
59+
Limit the number of videos you want to get.
6060
sleep (``int``, *optional*):
61-
Time to sleep between api calls to youtube in order to prevent getting blocked. Defaults to `1`.
61+
Seconds to sleep between API calls to youtube, in order to prevent getting blocked. Defaults to ``1``.
6262
"""
6363

6464
url = f'https://www.youtube.com/playlist?list={playlist_id}'
@@ -75,9 +75,9 @@ def get_search(query: str, limit: int = None, sleep: int = 1, sort_by: str = 're
7575
query (``str``):
7676
The term you want to search for.
7777
limit (``int``, *optional*):
78-
Limit to number of videos you want to get.
78+
Limit the number of videos you want to get.
7979
sleep (``int``, *optional*):
80-
Time to sleep between api calls to youtube in order to prevent getting blocked. Defaults to `1`.
80+
Seconds to sleep between API calls to youtube, in order to prevent getting blocked. Defaults to ``1``.
8181
sort_by (``str``, *optional*):
8282
In what order to retrive to videos. Pass one of the following values.
8383
``"relevance"``: Get the new videos in order of relevance.

0 commit comments

Comments
 (0)