docs: document the need to specify kind in getComments signature example

bramdelta · bramdelta · commit 0a8546f9e3a4 · 2025-03-09T20:37:46.000-04:00
diff --git a/src/comments/getComments.ts b/src/comments/getComments.ts
@@ -30,7 +30,7 @@ import type { Comments, GetCommentsResponse } from "./models";
  * // Retrieving game/achievement comments
  * const gameWallComments = await getComments(
  *   authorization,
- *   { identifier: 20294, count: 4, offset: 0 },
+ *   { identifier: 20294, kind: 1 count: 4, offset: 0 },
  * );
  *
  * // Retrieving comments on a user's wall

Original file line number	Diff line number	Diff line change
`@@ -30,7 +30,7 @@ import type { Comments, GetCommentsResponse } from "./models";`
`30`	`30`	`* // Retrieving game/achievement comments`
`31`	`31`	`* const gameWallComments = await getComments(`
`32`	`32`	`* authorization,`
`33`		`- * { identifier: 20294, count: 4, offset: 0 },`
	`33`	`+ * { identifier: 20294, kind: 1 count: 4, offset: 0 },`
`34`	`34`	`* );`
`35`	`35`	`*`
`36`	`36`	`* // Retrieving comments on a user's wall`