chore(Comments): reword a few things in the docs

LuanRT · Jan 11, 2023 · 870b281 · 870b281
1 parent 1aedbd3
commit 870b281
Show file tree

Hide file tree

Showing 2 changed files with 4 additions and 4 deletions.
diff --git a/examples/comments/README.md b/examples/comments/README.md
@@ -25,11 +25,11 @@ A list of comment threads. **Note:** More about comment threads [**here**](./Com
 
 <a name="applysort"></a>
 ### applySort(sort)
-Sorts the comments with the given sort type.
+Applies given sort option to the comments.
 
 | Param | Type | Description |
 | --- | --- | --- |
-| sort | `string` | Sort type. Can be `TOP_COMMENTS`, `NEWEST_FIRST` |
+| sort | `string` | Sort option. Can be `TOP_COMMENTS`, `NEWEST_FIRST` |
 
 **Returns:** [`Promise.<Comments>`](../../src/parser/youtube/Comments.ts)
 

diff --git a/src/parser/youtube/Comments.ts b/src/parser/youtube/Comments.ts
@@ -43,12 +43,12 @@ class Comments {
   }
 
   /**
-   * Sorts the comments with the given sort type.
+   * Applies given sort option to the comments.
    * @param sort - Sort type.
    */
   async applySort(sort: 'TOP_COMMENTS' | 'NEWEST_FIRST'): Promise<Comments> {
     if (!this.header)
-      throw new InnertubeError('Page header is missing. Cannot apply sort filter.');
+      throw new InnertubeError('Page header is missing. Cannot apply sort option.');
 
     let button;