Skip to content

Commit 7f6a0be

Browse files
Update docstrings
1 parent 924c902 commit 7f6a0be

File tree

1 file changed

+11
-4
lines changed

1 file changed

+11
-4
lines changed

src/redditpythonapi/reddit.py

Lines changed: 11 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -74,8 +74,11 @@ async def subreddit_articles(
7474
7575
Args:
7676
subreddit (str): subreddit to load articles from
77-
limit (int): up to how many articles should be loaded
78-
sort (ArticlesSortType): sort type to use when loading articles
77+
sort (ArticlesSortType | None): sort type to use when loading articles, "hot" by default
78+
time (ArticlesSortTime | None): sort time to use when loading articles,
79+
by default not passed onto Reddit API
80+
limit (int | None): up to how many articles should be loaded,
81+
by default not passed onto Reddit API
7982
8083
Returns:
8184
list[Article]: list of loaded articles from the given subreddit
@@ -96,8 +99,12 @@ async def user_articles(
9699
97100
Args:
98101
user (str): Reddit user to load articles from
99-
limit (int): up to how many articles should be loaded
100-
sort (ArticlesSortType): sort type to use when loading articles
102+
sort (ArticlesSortType | None): sort type to use when loading articles,
103+
by default not passed onto Reddit API
104+
time (ArticlesSortTime | None): sort time to use when loading articles,
105+
by default not passed onto Reddit API
106+
limit (int | None): up to how many articles should be loaded,
107+
by default not passed onto Reddit API
101108
102109
Returns:
103110
list[Article]: list of loaded articles from the Reddit user

0 commit comments

Comments
 (0)