From 4ea8e88ad3e9afa84620b8c2c964dfa4c3924e39 Mon Sep 17 00:00:00 2001 From: caneleex Date: Mon, 10 Jan 2022 05:30:12 +0100 Subject: [PATCH] Clear up some events' documentation wording (#1974) --- .../java/net/dv8tion/jda/api/events/guild/GuildBanEvent.java | 2 +- .../guild/member/update/GuildMemberUpdateAvatarEvent.java | 2 +- .../guild/member/update/GuildMemberUpdateBoostTimeEvent.java | 2 +- .../guild/member/update/GuildMemberUpdateNicknameEvent.java | 2 +- .../guild/member/update/GuildMemberUpdatePendingEvent.java | 2 +- 5 files changed, 5 insertions(+), 5 deletions(-) diff --git a/src/main/java/net/dv8tion/jda/api/events/guild/GuildBanEvent.java b/src/main/java/net/dv8tion/jda/api/events/guild/GuildBanEvent.java index adf7769b67..bac44f04b4 100644 --- a/src/main/java/net/dv8tion/jda/api/events/guild/GuildBanEvent.java +++ b/src/main/java/net/dv8tion/jda/api/events/guild/GuildBanEvent.java @@ -24,7 +24,7 @@ /** * Indicates that a {@link net.dv8tion.jda.api.entities.User User} was banned from a {@link net.dv8tion.jda.api.entities.Guild Guild}. * - *

Can be used to retrieve the user who was banned (if available) and triggering guild. + *

Can be used to retrieve the user who was banned (if available) and the triggering guild. *
Note: This does not directly indicate that a Member is removed from the Guild! * * @see net.dv8tion.jda.api.events.guild.member.GuildMemberRemoveEvent GuildMemberRemoveEvent diff --git a/src/main/java/net/dv8tion/jda/api/events/guild/member/update/GuildMemberUpdateAvatarEvent.java b/src/main/java/net/dv8tion/jda/api/events/guild/member/update/GuildMemberUpdateAvatarEvent.java index d03a1d03bd..a70d36c292 100644 --- a/src/main/java/net/dv8tion/jda/api/events/guild/member/update/GuildMemberUpdateAvatarEvent.java +++ b/src/main/java/net/dv8tion/jda/api/events/guild/member/update/GuildMemberUpdateAvatarEvent.java @@ -25,7 +25,7 @@ /** * Indicates that a {@link net.dv8tion.jda.api.entities.Member Member} updated their {@link net.dv8tion.jda.api.entities.Guild Guild} avatar. * - *

Can be used to retrieve members who change their per guild avatar, triggering guild, the old avatar id and the new avatar id. + *

Can be used to retrieve members who change their per guild avatar, the triggering guild, the old avatar id and the new avatar id. * *

Identifier: {@code avatar} * diff --git a/src/main/java/net/dv8tion/jda/api/events/guild/member/update/GuildMemberUpdateBoostTimeEvent.java b/src/main/java/net/dv8tion/jda/api/events/guild/member/update/GuildMemberUpdateBoostTimeEvent.java index b00b15dca9..0e6148ebd9 100644 --- a/src/main/java/net/dv8tion/jda/api/events/guild/member/update/GuildMemberUpdateBoostTimeEvent.java +++ b/src/main/java/net/dv8tion/jda/api/events/guild/member/update/GuildMemberUpdateBoostTimeEvent.java @@ -27,7 +27,7 @@ * Indicates that a {@link net.dv8tion.jda.api.entities.Member Member} updated their {@link net.dv8tion.jda.api.entities.Guild Guild} boost time. *
This happens when a member started or stopped boosting a guild. * - *

Can be used to retrieve members who boosted, triggering guild. + *

Can be used to retrieve members who boosted and the triggering guild. * *

Identifier: {@code boost_time} * diff --git a/src/main/java/net/dv8tion/jda/api/events/guild/member/update/GuildMemberUpdateNicknameEvent.java b/src/main/java/net/dv8tion/jda/api/events/guild/member/update/GuildMemberUpdateNicknameEvent.java index 25d745ef48..bb07e30235 100644 --- a/src/main/java/net/dv8tion/jda/api/events/guild/member/update/GuildMemberUpdateNicknameEvent.java +++ b/src/main/java/net/dv8tion/jda/api/events/guild/member/update/GuildMemberUpdateNicknameEvent.java @@ -25,7 +25,7 @@ /** * Indicates that a {@link net.dv8tion.jda.api.entities.Member Member} updated their {@link net.dv8tion.jda.api.entities.Guild Guild} nickname. * - *

Can be used to retrieve members who change their nickname, triggering guild, the old nick and the new nick. + *

Can be used to retrieve members who change their nickname, the triggering guild, the old nick and the new nick. * *

Identifier: {@code nick} * diff --git a/src/main/java/net/dv8tion/jda/api/events/guild/member/update/GuildMemberUpdatePendingEvent.java b/src/main/java/net/dv8tion/jda/api/events/guild/member/update/GuildMemberUpdatePendingEvent.java index 68b0853fc0..344099a156 100644 --- a/src/main/java/net/dv8tion/jda/api/events/guild/member/update/GuildMemberUpdatePendingEvent.java +++ b/src/main/java/net/dv8tion/jda/api/events/guild/member/update/GuildMemberUpdatePendingEvent.java @@ -25,7 +25,7 @@ /** * Indicates that a {@link Member Member} has agreed to Membership Screening requirements. * - *

Can be used to retrieve members who have agreed to Membership Screening requirements. + *

Can be used to retrieve members who have agreed to Membership Screening requirements and the triggering guild. * *

Identifier: {@code pending} *