From a6772f9cf8fc8670c636c48bd71f60c330c7a580 Mon Sep 17 00:00:00 2001 From: Sebastian Espei Date: Wed, 22 Feb 2023 00:36:41 +0100 Subject: [PATCH] docs: improve TwitchHelix#getClips javadoc (#731) * Improve javadoc comment from method getClips * chore: apply suggestions from code review * chore: add paragraph spacing --------- Co-authored-by: iProdigy Co-authored-by: iProdigy --- .../java/com/github/twitch4j/helix/TwitchHelix.java | 10 ++++++---- 1 file changed, 6 insertions(+), 4 deletions(-) diff --git a/rest-helix/src/main/java/com/github/twitch4j/helix/TwitchHelix.java b/rest-helix/src/main/java/com/github/twitch4j/helix/TwitchHelix.java index 50330f1c6..785e43b07 100644 --- a/rest-helix/src/main/java/com/github/twitch4j/helix/TwitchHelix.java +++ b/rest-helix/src/main/java/com/github/twitch4j/helix/TwitchHelix.java @@ -1325,11 +1325,13 @@ HystrixCommand createClip( /** * Gets clip information by clip ID (one or more), broadcaster ID (one only), or game ID (one only). - * Using user-token or app-token to increase rate limits. + *

+ * For clips returned by game_id or broadcaster_id, the list is in descending order by view count. + * For lists returned by id, the list is in the same order as the input IDs. * - * @param authToken User or App auth Token, for increased rate-limits - * @param broadcasterId ID of the broadcaster for whom clips are returned. The number of clips returned is determined by the first query-string parameter (default: 20). Results are ordered by view count. - * @param gameId ID of the game for which clips are returned. The number of clips returned is determined by the first query-string parameter (default: 20). Results are ordered by view count. + * @param authToken User or App access token. + * @param broadcasterId ID of the broadcaster for whom clips are returned. + * @param gameId ID of the game for which clips are returned. * @param id ID of the clip being queried. Limit: 100. * @param after Cursor for forward pagination: tells the server where to start fetching the next set of results, in a multi-page response. * @param before Cursor for backward pagination: tells the server where to start fetching the next set of results, in a multi-page response.