Skip to content

Commit ff78112

Browse files
committed
Adding method comments describing what each listing is.
1 parent fbb0a71 commit ff78112

File tree

1 file changed

+16
-0
lines changed

1 file changed

+16
-0
lines changed

RedditSharp/Reddit.cs

Lines changed: 16 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -405,21 +405,37 @@ public Listing<T> Search<T>(string query, Sorting sortE = Sorting.Relevance, Tim
405405

406406
#region SubredditSearching
407407

408+
/// <summary>
409+
/// Returns a Listing of newly created subreddits.
410+
/// </summary>
411+
/// <returns></returns>
408412
public Listing<Subreddit> GetNewSubreddits()
409413
{
410414
return new Listing<Subreddit>(this, NewSubredditsUrl, WebAgent);
411415
}
412416

417+
/// <summary>
418+
/// Returns a Listing of the most popular subreddits.
419+
/// </summary>
420+
/// <returns></returns>
413421
public Listing<Subreddit> GetPopularSubreddits()
414422
{
415423
return new Listing<Subreddit>(this, PopularSubredditsUrl, WebAgent);
416424
}
417425

426+
/// <summary>
427+
/// Returns a Listing of Gold-only subreddits. This endpoint will not return anything if the authenticated Reddit account does not currently have gold.
428+
/// </summary>
429+
/// <returns></returns>
418430
public Listing<Subreddit> GetGoldSubreddits()
419431
{
420432
return new Listing<Subreddit>(this, GoldSubredditsUrl, WebAgent);
421433
}
422434

435+
/// <summary>
436+
/// Returns the Listing of default subreddits.
437+
/// </summary>
438+
/// <returns></returns>
423439
public Listing<Subreddit> GetDefaultSubreddits()
424440
{
425441
return new Listing<Subreddit>(this, DefaultSubredditsUrl, WebAgent);

0 commit comments

Comments
 (0)