@@ -141,13 +141,13 @@ public List<TopHelperStats> computeTopHelpersDescending(Guild guild, TimeRange r
141
141
142
142
/**
143
143
* Retrieves the member-data to a given list of top helpers.
144
- * <p>
145
- * The resulting list is in the same order as the given list and will contain {@code null} for
146
- * any Top Helper who is not member of the guild anymore.
147
144
*
148
145
* @param topHelpers the list of top helpers to retrieve member-data for
149
146
* @param guild the guild the top helpers are members of
150
- * @return list of member-data for each top helper, same size and same order.
147
+ * @return list of member-data for each top helper. If a Top helper is not member of the guild
148
+ * anymore, it will not be contained in the list of members. Also, the order is not
149
+ * given and in particular does not have to line up with the original order of Top
150
+ * Helpers.
151
151
*/
152
152
public static Task <List <Member >> retrieveTopHelperMembers (List <TopHelperStats > topHelpers ,
153
153
Guild guild ) {
@@ -160,8 +160,8 @@ public static Task<List<Member>> retrieveTopHelperMembers(List<TopHelperStats> t
160
160
* Name and Message lengths.
161
161
*
162
162
* @param topHelpers the list of top helpers to represent
163
- * @param members the list of member-data that lines up with the topHelpers , for example given
164
- * by {@link #retrieveTopHelperMembers(List, Guild)}
163
+ * @param members the list of available member-data, for example given by
164
+ * {@link #retrieveTopHelperMembers(List, Guild)}
165
165
* @return ASCII table representing the Top Helpers
166
166
*/
167
167
public static String asAsciiTableWithIds (Collection <TopHelperStats > topHelpers ,
@@ -174,8 +174,8 @@ public static String asAsciiTableWithIds(Collection<TopHelperStats> topHelpers,
174
174
* Name and Message lengths.
175
175
*
176
176
* @param topHelpers the list of top helpers to represent
177
- * @param members the list of member-data that lines up with the topHelpers , for example given
178
- * by {@link #retrieveTopHelperMembers(List, Guild)}
177
+ * @param members the list of available member-data, for example given by
178
+ * {@link #retrieveTopHelperMembers(List, Guild)}
179
179
* @return ASCII table representing the Top Helpers
180
180
*/
181
181
public static String asAsciiTable (Collection <TopHelperStats > topHelpers ,
0 commit comments