Skip to content

Commit 0b4a8a9

Browse files
galactic-magpieFairlyCaffeinatedstacy-qqqben-harris-5
authored
v0.15.0 release (#234)
Release docs for minor bump 0.15.0 --------- Co-authored-by: FairlyCaffeinated <david.muzi@reddit.com> Co-authored-by: Stacy <143668017+stacy-qqq@users.noreply.github.com> Co-authored-by: ben.harris <ben.harris@reddit.com>
1 parent 06df617 commit 0b4a8a9

1,829 files changed

Lines changed: 98111 additions & 264 deletions

File tree

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

‎docs/api/public-api/classes/Comment.md‎

Lines changed: 4 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -646,7 +646,10 @@ The `runAs` option is ignored when editing a comment.
646646
647647
**`Experimental`**
648648

649-
Filters the comment. When a comment is filtered, it is added to the ModQueue for review. By default, filtered comments are hidden while in the queue. Set `keep` to `true` to keep the comment visible. Set `reason` to show moderators a reason; when `keep` is `true`, the reason is also shown on the comment.
649+
Filters the comment. When a comment is filtered, it is added to the ModQueue for review. By
650+
default, filtered comments are hidden while in the queue. Set `keep` to `true` to keep the
651+
comment visible. Set `reason` to show moderators a reason; when `keep` is `true`, the reason
652+
is also shown on the comment.
650653

651654
#### Parameters
652655

‎docs/api/public-api/classes/Post.md‎

Lines changed: 4 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -890,7 +890,10 @@ edited state from the response.
890890
891891
**`Experimental`**
892892

893-
Filters a post. When a post is filtered, it is added to the ModQueue for review. By default, filtered posts are hidden while in the queue. Set `keep` to `true` to keep the post visible. Set `reason` to show moderators a reason; when `keep` is `true`, the reason is also shown on the post.
893+
Filters a post. When a post is filtered, it is added to the ModQueue for
894+
review. By default, filtered posts are hidden while in the queue. Set
895+
`keep` to `true` to keep the post visible. Set `reason` to show moderators
896+
a reason; when `keep` is `true`, the reason is also shown on the post.
894897

895898
#### Parameters
896899

‎docs/api/public-api/classes/RedditAPIClient.md‎

Lines changed: 10 additions & 49 deletions
Original file line numberDiff line numberDiff line change
@@ -775,7 +775,10 @@ The edited FlairTemplate object.
775775
776776
**`Experimental`**
777777

778-
Filters a post or comment. When a post or comment is filtered, it is added to the ModQueue for review. By default, filtered content is hidden while in the queue. Set `keep` to `true` to keep the content visible. Set `reason` to show moderators a reason; when `keep` is `true`, the reason is also shown on the content.
778+
Filters a post or comment. When a post or comment is filtered, it is added to the ModQueue for
779+
review. By default, filtered content is hidden while in the queue. Set `keep` to `true` to keep
780+
the content visible. Set `reason` to show moderators a reason; when `keep` is `true`, the
781+
reason is also shown on the content.
779782

780783
#### Parameters
781784

@@ -2760,79 +2763,37 @@ A Listing of SubredditWikiContributorUser objects.
27602763

27612764
### getWikiPage()
27622765

2763-
#### Call Signature
2764-
2765-
> **getWikiPage**(`subredditName`, `page`, `revisionId`): `Promise`\<[`WikiPage`](WikiPage.md)\>
2766-
2767-
Get a specific revision of a wiki page from a subreddit.
2768-
2769-
##### Parameters
2770-
2771-
###### subredditName
2772-
2773-
`string`
2774-
2775-
The name of the subreddit to get the wiki page from.
2776-
2777-
###### page
2778-
2779-
`string`
2780-
2781-
The name of the wiki page to get.
2782-
2783-
###### revisionId
2784-
2785-
The revision ID of the wiki page version to get. Leaving it empty returns the latest version.
2786-
2787-
`undefined` | `` `${string}-${string}-${string}-${string}-${string}` ``
2788-
2789-
##### Returns
2790-
2791-
`Promise`\<[`WikiPage`](WikiPage.md)\>
2792-
2793-
The requested WikiPage object.
2794-
2795-
##### Deprecated
2796-
2797-
Pass a [GetWikiPageOptions](../type-aliases/GetWikiPageOptions.md) object as the third argument instead.
2798-
2799-
##### Inherited from
2800-
2801-
[`RedditClient`](RedditClient.md).[`getWikiPage`](RedditClient.md#getwikipage)
2802-
2803-
#### Call Signature
2804-
28052766
> **getWikiPage**(`subredditName`, `page`, `options`?): `Promise`\<[`WikiPage`](WikiPage.md)\>
28062767
28072768
Get a wiki page from a subreddit.
28082769

2809-
##### Parameters
2770+
#### Parameters
28102771

2811-
###### subredditName
2772+
##### subredditName
28122773

28132774
`string`
28142775

28152776
The name of the subreddit to get the wiki page from.
28162777

2817-
###### page
2778+
##### page
28182779

28192780
`string`
28202781

28212782
The name of the wiki page to get.
28222783

2823-
###### options?
2784+
##### options?
28242785

28252786
[`GetWikiPageOptions`](../type-aliases/GetWikiPageOptions.md)
28262787

28272788
Options for the request.
28282789

2829-
##### Returns
2790+
#### Returns
28302791

28312792
`Promise`\<[`WikiPage`](WikiPage.md)\>
28322793

28332794
The requested WikiPage object.
28342795

2835-
##### Inherited from
2796+
#### Inherited from
28362797

28372798
[`RedditClient`](RedditClient.md).[`getWikiPage`](RedditClient.md#getwikipage)
28382799

‎docs/api/public-api/classes/RedditClient.md‎

Lines changed: 9 additions & 44 deletions
Original file line numberDiff line numberDiff line change
@@ -685,7 +685,10 @@ The edited FlairTemplate object.
685685
686686
**`Experimental`**
687687

688-
Filters a post or comment. When a post or comment is filtered, it is added to the ModQueue for review. By default, filtered content is hidden while in the queue. Set `keep` to `true` to keep the content visible. Set `reason` to show moderators a reason; when `keep` is `true`, the reason is also shown on the content.
688+
Filters a post or comment. When a post or comment is filtered, it is added to the ModQueue for
689+
review. By default, filtered content is hidden while in the queue. Set `keep` to `true` to keep
690+
the content visible. Set `reason` to show moderators a reason; when `keep` is `true`, the
691+
reason is also shown on the content.
689692

690693
#### Parameters
691694

@@ -2400,69 +2403,31 @@ A Listing of SubredditWikiContributorUser objects.
24002403

24012404
### getWikiPage()
24022405

2403-
#### Call Signature
2404-
2405-
> **getWikiPage**(`subredditName`, `page`, `revisionId`): `Promise`\<[`WikiPage`](WikiPage.md)\>
2406-
2407-
Get a specific revision of a wiki page from a subreddit.
2408-
2409-
##### Parameters
2410-
2411-
###### subredditName
2412-
2413-
`string`
2414-
2415-
The name of the subreddit to get the wiki page from.
2416-
2417-
###### page
2418-
2419-
`string`
2420-
2421-
The name of the wiki page to get.
2422-
2423-
###### revisionId
2424-
2425-
The revision ID of the wiki page version to get. Leaving it empty returns the latest version.
2426-
2427-
`undefined` | `` `${string}-${string}-${string}-${string}-${string}` ``
2428-
2429-
##### Returns
2430-
2431-
`Promise`\<[`WikiPage`](WikiPage.md)\>
2432-
2433-
The requested WikiPage object.
2434-
2435-
##### Deprecated
2436-
2437-
Pass a [GetWikiPageOptions](../type-aliases/GetWikiPageOptions.md) object as the third argument instead.
2438-
2439-
#### Call Signature
2440-
24412406
> **getWikiPage**(`subredditName`, `page`, `options`?): `Promise`\<[`WikiPage`](WikiPage.md)\>
24422407
24432408
Get a wiki page from a subreddit.
24442409

2445-
##### Parameters
2410+
#### Parameters
24462411

2447-
###### subredditName
2412+
##### subredditName
24482413

24492414
`string`
24502415

24512416
The name of the subreddit to get the wiki page from.
24522417

2453-
###### page
2418+
##### page
24542419

24552420
`string`
24562421

24572422
The name of the wiki page to get.
24582423

2459-
###### options?
2424+
##### options?
24602425

24612426
[`GetWikiPageOptions`](../type-aliases/GetWikiPageOptions.md)
24622427

24632428
Options for the request.
24642429

2465-
##### Returns
2430+
#### Returns
24662431

24672432
`Promise`\<[`WikiPage`](WikiPage.md)\>
24682433

‎docs/api/redditapi/RedditClient/classes/RedditClient.md‎

Lines changed: 9 additions & 44 deletions
Original file line numberDiff line numberDiff line change
@@ -681,7 +681,10 @@ The edited FlairTemplate object.
681681
682682
**`Experimental`**
683683

684-
Filters a post or comment. When a post or comment is filtered, it is added to the ModQueue for review. By default, filtered content is hidden while in the queue. Set `keep` to `true` to keep the content visible. Set `reason` to show moderators a reason; when `keep` is `true`, the reason is also shown on the content.
684+
Filters a post or comment. When a post or comment is filtered, it is added to the ModQueue for
685+
review. By default, filtered content is hidden while in the queue. Set `keep` to `true` to keep
686+
the content visible. Set `reason` to show moderators a reason; when `keep` is `true`, the
687+
reason is also shown on the content.
685688

686689
#### Parameters
687690

@@ -2396,69 +2399,31 @@ A Listing of SubredditWikiContributorUser objects.
23962399

23972400
### getWikiPage()
23982401

2399-
#### Call Signature
2400-
2401-
> **getWikiPage**(`subredditName`, `page`, `revisionId`): `Promise`\<[`WikiPage`](../../models/classes/WikiPage.md)\>
2402-
2403-
Get a specific revision of a wiki page from a subreddit.
2404-
2405-
##### Parameters
2406-
2407-
###### subredditName
2408-
2409-
`string`
2410-
2411-
The name of the subreddit to get the wiki page from.
2412-
2413-
###### page
2414-
2415-
`string`
2416-
2417-
The name of the wiki page to get.
2418-
2419-
###### revisionId
2420-
2421-
The revision ID of the wiki page version to get. Leaving it empty returns the latest version.
2422-
2423-
`undefined` | `` `${string}-${string}-${string}-${string}-${string}` ``
2424-
2425-
##### Returns
2426-
2427-
`Promise`\<[`WikiPage`](../../models/classes/WikiPage.md)\>
2428-
2429-
The requested WikiPage object.
2430-
2431-
##### Deprecated
2432-
2433-
Pass a [GetWikiPageOptions](../../models/type-aliases/GetWikiPageOptions.md) object as the third argument instead.
2434-
2435-
#### Call Signature
2436-
24372402
> **getWikiPage**(`subredditName`, `page`, `options`?): `Promise`\<[`WikiPage`](../../models/classes/WikiPage.md)\>
24382403
24392404
Get a wiki page from a subreddit.
24402405

2441-
##### Parameters
2406+
#### Parameters
24422407

2443-
###### subredditName
2408+
##### subredditName
24442409

24452410
`string`
24462411

24472412
The name of the subreddit to get the wiki page from.
24482413

2449-
###### page
2414+
##### page
24502415

24512416
`string`
24522417

24532418
The name of the wiki page to get.
24542419

2455-
###### options?
2420+
##### options?
24562421

24572422
[`GetWikiPageOptions`](../../models/type-aliases/GetWikiPageOptions.md)
24582423

24592424
Options for the request.
24602425

2461-
##### Returns
2426+
#### Returns
24622427

24632428
`Promise`\<[`WikiPage`](../../models/classes/WikiPage.md)\>
24642429

‎docs/api/redditapi/models/classes/Comment.md‎

Lines changed: 4 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -634,7 +634,10 @@ The `runAs` option is ignored when editing a comment.
634634
635635
**`Experimental`**
636636

637-
Filters the comment. When a comment is filtered, it is added to the ModQueue for review. By default, filtered comments are hidden while in the queue. Set `keep` to `true` to keep the comment visible. Set `reason` to show moderators a reason; when `keep` is `true`, the reason is also shown on the comment.
637+
Filters the comment. When a comment is filtered, it is added to the ModQueue for review. By
638+
default, filtered comments are hidden while in the queue. Set `keep` to `true` to keep the
639+
comment visible. Set `reason` to show moderators a reason; when `keep` is `true`, the reason
640+
is also shown on the comment.
638641

639642
#### Parameters
640643

‎docs/api/redditapi/models/classes/Post.md‎

Lines changed: 4 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -878,7 +878,10 @@ edited state from the response.
878878
879879
**`Experimental`**
880880

881-
Filters a post. When a post is filtered, it is added to the ModQueue for review. By default, filtered posts are hidden while in the queue. Set `keep` to `true` to keep the post visible. Set `reason` to show moderators a reason; when `keep` is `true`, the reason is also shown on the post.
881+
Filters a post. When a post is filtered, it is added to the ModQueue for
882+
review. By default, filtered posts are hidden while in the queue. Set
883+
`keep` to `true` to keep the post visible. Set `reason` to show moderators
884+
a reason; when `keep` is `true`, the reason is also shown on the post.
882885

883886
#### Parameters
884887

0 commit comments

Comments
 (0)