Merge pull request #474 from Foorcee/filter

Clarify Audience#filterAudience(Predicate) docs
KyoriPowered · Dec 11, 2021 · e4205ba · e4205ba
2 parents bbc26f6 + 55cdc61
commit e4205ba
Showing 1 changed file with 2 additions and 1 deletion.
diff --git a/api/src/main/java/net/kyori/adventure/audience/Audience.java b/api/src/main/java/net/kyori/adventure/audience/Audience.java
@@ -147,7 +147,8 @@ public interface Audience extends Pointered {
    * If they do, they <em>may</em> test themselves against the provided {@code filter} first, and if the test fails return an empty audience skipping any contained children.
    * If they do not, they <em>must not</em> test themselves against the filter, only testing their children.</p>
    *
-   * @param filter the filter
+   * @param filter a filter that determines if an audience should be included
+   * @return an audience providing a snapshot of all audiences that match the predicate when this method is invoked
    * @since 4.9.0
    */
   default @NotNull Audience filterAudience(final @NotNull Predicate<? super Audience> filter) {