From 2817cf8daae81ce11fc3052b9cff3f28c806ff48 Mon Sep 17 00:00:00 2001 From: Dikran Samarjian Date: Fri, 4 Sep 2026 11:06:34 -0700 Subject: [PATCH] update incomplete example --- docs/api/public-api/classes/Comment.md | 3 +-- docs/api/public-api/classes/Post.md | 3 +-- docs/api/public-api/classes/RedditAPIClient.md | 3 +-- docs/api/public-api/classes/RedditClient.md | 3 +-- docs/api/redditapi/RedditClient/classes/RedditClient.md | 3 +-- docs/api/redditapi/models/classes/Comment.md | 3 +-- docs/api/redditapi/models/classes/Post.md | 3 +-- .../api/redditapi/RedditAPIClient/classes/RedditAPIClient.md | 3 +-- .../version-0.13/api/redditapi/models/classes/Comment.md | 3 +-- .../version-0.13/api/redditapi/models/classes/Post.md | 3 +-- versioned_docs/version-0.14/api/public-api/classes/Comment.md | 3 +-- versioned_docs/version-0.14/api/public-api/classes/Post.md | 3 +-- .../version-0.14/api/public-api/classes/RedditAPIClient.md | 3 +-- .../version-0.14/api/public-api/classes/RedditClient.md | 3 +-- .../api/redditapi/RedditClient/classes/RedditClient.md | 3 +-- .../version-0.14/api/redditapi/models/classes/Comment.md | 3 +-- .../version-0.14/api/redditapi/models/classes/Post.md | 3 +-- 17 files changed, 17 insertions(+), 34 deletions(-) diff --git a/docs/api/public-api/classes/Comment.md b/docs/api/public-api/classes/Comment.md index d3e10b9b..bc2d5b4c 100644 --- a/docs/api/public-api/classes/Comment.md +++ b/docs/api/public-api/classes/Comment.md @@ -646,8 +646,7 @@ The `runAs` option is ignored when editing a comment. **`Experimental`** -Filters the comment. When a comment is filtered, it is added to the ModQueue for review, and in addition: -- if +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. #### Parameters diff --git a/docs/api/public-api/classes/Post.md b/docs/api/public-api/classes/Post.md index 9a974281..46772049 100644 --- a/docs/api/public-api/classes/Post.md +++ b/docs/api/public-api/classes/Post.md @@ -890,8 +890,7 @@ edited state from the response. **`Experimental`** -Filters a post. When a post is filtered, it is added to the ModQueue for review, and in addition: -- if +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. #### Parameters diff --git a/docs/api/public-api/classes/RedditAPIClient.md b/docs/api/public-api/classes/RedditAPIClient.md index d5be6afd..ad23ec81 100644 --- a/docs/api/public-api/classes/RedditAPIClient.md +++ b/docs/api/public-api/classes/RedditAPIClient.md @@ -775,8 +775,7 @@ The edited FlairTemplate object. **`Experimental`** -Filters a post or comment. When a post or comment is filtered, it is added to the ModQueue for review, and in addition: -- if +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. #### Parameters diff --git a/docs/api/public-api/classes/RedditClient.md b/docs/api/public-api/classes/RedditClient.md index 4ee6e3d6..2275be9f 100644 --- a/docs/api/public-api/classes/RedditClient.md +++ b/docs/api/public-api/classes/RedditClient.md @@ -685,8 +685,7 @@ The edited FlairTemplate object. **`Experimental`** -Filters a post or comment. When a post or comment is filtered, it is added to the ModQueue for review, and in addition: -- if +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. #### Parameters diff --git a/docs/api/redditapi/RedditClient/classes/RedditClient.md b/docs/api/redditapi/RedditClient/classes/RedditClient.md index 4b8042e6..305b1e61 100644 --- a/docs/api/redditapi/RedditClient/classes/RedditClient.md +++ b/docs/api/redditapi/RedditClient/classes/RedditClient.md @@ -681,8 +681,7 @@ The edited FlairTemplate object. **`Experimental`** -Filters a post or comment. When a post or comment is filtered, it is added to the ModQueue for review, and in addition: -- if +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. #### Parameters diff --git a/docs/api/redditapi/models/classes/Comment.md b/docs/api/redditapi/models/classes/Comment.md index 1f1074a6..d748b784 100644 --- a/docs/api/redditapi/models/classes/Comment.md +++ b/docs/api/redditapi/models/classes/Comment.md @@ -634,8 +634,7 @@ The `runAs` option is ignored when editing a comment. **`Experimental`** -Filters the comment. When a comment is filtered, it is added to the ModQueue for review, and in addition: -- if +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. #### Parameters diff --git a/docs/api/redditapi/models/classes/Post.md b/docs/api/redditapi/models/classes/Post.md index 3d51ec76..6ad8f991 100644 --- a/docs/api/redditapi/models/classes/Post.md +++ b/docs/api/redditapi/models/classes/Post.md @@ -878,8 +878,7 @@ edited state from the response. **`Experimental`** -Filters a post. When a post is filtered, it is added to the ModQueue for review, and in addition: -- if +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. #### Parameters diff --git a/versioned_docs/version-0.13/api/redditapi/RedditAPIClient/classes/RedditAPIClient.md b/versioned_docs/version-0.13/api/redditapi/RedditAPIClient/classes/RedditAPIClient.md index a39b0620..d5891880 100644 --- a/versioned_docs/version-0.13/api/redditapi/RedditAPIClient/classes/RedditAPIClient.md +++ b/versioned_docs/version-0.13/api/redditapi/RedditAPIClient/classes/RedditAPIClient.md @@ -621,8 +621,7 @@ The edited FlairTemplate object. **`Experimental`** -Filters a post or comment. When a post or comment is filtered, it is added to the ModQueue for review, and in addition: -- if +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. #### Parameters diff --git a/versioned_docs/version-0.13/api/redditapi/models/classes/Comment.md b/versioned_docs/version-0.13/api/redditapi/models/classes/Comment.md index bbe50a5e..c843130f 100644 --- a/versioned_docs/version-0.13/api/redditapi/models/classes/Comment.md +++ b/versioned_docs/version-0.13/api/redditapi/models/classes/Comment.md @@ -534,8 +534,7 @@ id of a Removal Reason - you can leave this as an empty string if you don't have **`Experimental`** -Filters the comment. When a comment is filtered, it is added to the ModQueue for review, and in addition: -- if +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. #### Parameters diff --git a/versioned_docs/version-0.13/api/redditapi/models/classes/Post.md b/versioned_docs/version-0.13/api/redditapi/models/classes/Post.md index a18225b5..96fd749c 100644 --- a/versioned_docs/version-0.13/api/redditapi/models/classes/Post.md +++ b/versioned_docs/version-0.13/api/redditapi/models/classes/Post.md @@ -758,8 +758,7 @@ id of a Removal Reason - you can leave this as an empty string if you don't have **`Experimental`** -Filters a post. When a post is filtered, it is added to the ModQueue for review, and in addition: -- if +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. #### Parameters diff --git a/versioned_docs/version-0.14/api/public-api/classes/Comment.md b/versioned_docs/version-0.14/api/public-api/classes/Comment.md index 6d3a8ea6..15a8488c 100644 --- a/versioned_docs/version-0.14/api/public-api/classes/Comment.md +++ b/versioned_docs/version-0.14/api/public-api/classes/Comment.md @@ -540,8 +540,7 @@ Add a mod note for why the comment was removed **`Experimental`** -Filters the comment. When a comment is filtered, it is added to the ModQueue for review, and in addition: -- if +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. #### Parameters diff --git a/versioned_docs/version-0.14/api/public-api/classes/Post.md b/versioned_docs/version-0.14/api/public-api/classes/Post.md index 250c9b41..a5227313 100644 --- a/versioned_docs/version-0.14/api/public-api/classes/Post.md +++ b/versioned_docs/version-0.14/api/public-api/classes/Post.md @@ -766,8 +766,7 @@ Add a mod note for why the post was removed **`Experimental`** -Filters a post. When a post is filtered, it is added to the ModQueue for review, and in addition: -- if +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. #### Parameters diff --git a/versioned_docs/version-0.14/api/public-api/classes/RedditAPIClient.md b/versioned_docs/version-0.14/api/public-api/classes/RedditAPIClient.md index 60aff6bf..1c7dd048 100644 --- a/versioned_docs/version-0.14/api/public-api/classes/RedditAPIClient.md +++ b/versioned_docs/version-0.14/api/public-api/classes/RedditAPIClient.md @@ -762,8 +762,7 @@ The edited FlairTemplate object. **`Experimental`** -Filters a post or comment. When a post or comment is filtered, it is added to the ModQueue for review, and in addition: -- if +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. #### Parameters diff --git a/versioned_docs/version-0.14/api/public-api/classes/RedditClient.md b/versioned_docs/version-0.14/api/public-api/classes/RedditClient.md index 78b792bd..5d834b73 100644 --- a/versioned_docs/version-0.14/api/public-api/classes/RedditClient.md +++ b/versioned_docs/version-0.14/api/public-api/classes/RedditClient.md @@ -672,8 +672,7 @@ The edited FlairTemplate object. **`Experimental`** -Filters a post or comment. When a post or comment is filtered, it is added to the ModQueue for review, and in addition: -- if +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. #### Parameters diff --git a/versioned_docs/version-0.14/api/redditapi/RedditClient/classes/RedditClient.md b/versioned_docs/version-0.14/api/redditapi/RedditClient/classes/RedditClient.md index 47a679d8..f13b60f4 100644 --- a/versioned_docs/version-0.14/api/redditapi/RedditClient/classes/RedditClient.md +++ b/versioned_docs/version-0.14/api/redditapi/RedditClient/classes/RedditClient.md @@ -668,8 +668,7 @@ The edited FlairTemplate object. **`Experimental`** -Filters a post or comment. When a post or comment is filtered, it is added to the ModQueue for review, and in addition: -- if +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. #### Parameters diff --git a/versioned_docs/version-0.14/api/redditapi/models/classes/Comment.md b/versioned_docs/version-0.14/api/redditapi/models/classes/Comment.md index 7f65e2e0..46589ed9 100644 --- a/versioned_docs/version-0.14/api/redditapi/models/classes/Comment.md +++ b/versioned_docs/version-0.14/api/redditapi/models/classes/Comment.md @@ -528,8 +528,7 @@ Add a mod note for why the comment was removed **`Experimental`** -Filters the comment. When a comment is filtered, it is added to the ModQueue for review, and in addition: -- if +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. #### Parameters diff --git a/versioned_docs/version-0.14/api/redditapi/models/classes/Post.md b/versioned_docs/version-0.14/api/redditapi/models/classes/Post.md index 18745b61..06d23f43 100644 --- a/versioned_docs/version-0.14/api/redditapi/models/classes/Post.md +++ b/versioned_docs/version-0.14/api/redditapi/models/classes/Post.md @@ -754,8 +754,7 @@ Add a mod note for why the post was removed **`Experimental`** -Filters a post. When a post is filtered, it is added to the ModQueue for review, and in addition: -- if +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. #### Parameters