More v5 documentation #2296

Sanduhr32 · 2022-10-22T19:27:42Z

Pull Request Etiquette

I have checked the PRs for upcoming features/bug fixes.
I have read the contributing guidelines.

Changes

Internal code
Library interface (affecting end-user code)
Documentation
Other: _____

Closes Issue:

Description

Finally intorduces pending documentation for new v5 functionalities

src/main/java/net/dv8tion/jda/api/entities/Message.java

src/main/java/net/dv8tion/jda/api/entities/ThreadMember.java

src/main/java/net/dv8tion/jda/api/entities/channel/concrete/ThreadChannel.java

src/main/java/net/dv8tion/jda/api/events/thread/member/ThreadMemberJoinEvent.java

Sanduhr32 · 2022-10-26T15:30:07Z

It's potentially breaking, because I removed a public attribute hopefully no-one uses right?

# Conflicts: # src/main/java/net/dv8tion/jda/internal/entities/ThreadMemberImpl.java

src/main/java/net/dv8tion/jda/api/entities/ThreadMember.java

src/main/java/net/dv8tion/jda/api/entities/channel/concrete/ThreadChannel.java

Co-authored-by: Austin Keener <keeneraustin@yahoo.com>

> that todo comment is outdated i think > getters should be fine already ~ Minn

…d.java Co-authored-by: Florian Spieß <business@minn.dev>

Sanduhr32 · 2022-10-30T11:42:11Z

All i have left todo, is figuring out when the ThreadMemberJoin event is fired (and received by JDA)

src/main/java/net/dv8tion/jda/api/events/thread/GenericThreadEvent.java

MinnDevelopment · 2022-11-02T09:24:51Z

src/main/java/net/dv8tion/jda/api/events/thread/member/GenericThreadMemberEvent.java

@@ -25,7 +25,15 @@
 import javax.annotation.Nonnull;
 import javax.annotation.Nullable;

-//TODO-v5: Docs
+/**
+ * Indicates that a {@link Member GuildMember} interacted with a {@link ThreadChannel} as a {@link ThreadMember}.


Interacted seems like a strange wording here, can't a member also be added by someone else (private threads) without "interacting"? Especially problematic because "interaction" is a defined term for a specific API.

I rephrased it similar to the GenericGuildMember event

src/main/java/net/dv8tion/jda/api/events/thread/member/GenericThreadMemberEvent.java

MinnDevelopment · 2022-11-02T09:26:06Z

src/main/java/net/dv8tion/jda/api/events/thread/member/GenericThreadMemberEvent.java

    @Nullable
    public ThreadMember getThreadMember()
    {
        return threadMember;
    }

+    /**
+     * The interacting {@link ThreadMember} as a {@link Member GuildMember}.


Suggested change

* The interacting {@link ThreadMember} as a {@link Member GuildMember}.

* The interacting {@link ThreadMember} as a {@link Member}.

I explicitly called it "guild member" for clarification

Yeah, its less clear in my opinion as it looks like a different type. Maybe do guild {@link Member} instead?

MinnDevelopment · 2022-11-02T09:26:11Z

src/main/java/net/dv8tion/jda/api/events/thread/member/GenericThreadMemberEvent.java

+    /**
+     * The interacting {@link ThreadMember} as a {@link Member GuildMember}.
+     *
+     * @return The interacting {@link ThreadMember} as a {@link Member GuildMember}.


Suggested change

* @return The interacting {@link ThreadMember} as a {@link Member GuildMember}.

* @return The interacting {@link ThreadMember} as a {@link Member}.

MinnDevelopment · 2022-11-02T09:27:23Z

src/main/java/net/dv8tion/jda/api/events/thread/member/ThreadMemberJoinEvent.java

+     * The joined {@link ThreadMember} as a {@link Member GuildMember}
+     * @return The joined {@link ThreadMember} as a {@link Member GuildMember}


Suggested change

* The joined {@link ThreadMember} as a {@link Member GuildMember}

* @return The joined {@link ThreadMember} as a {@link Member GuildMember}

* The joined {@link ThreadMember} as a {@link Member}

* @return The joined {@link ThreadMember} as a {@link Member}

MinnDevelopment · 2022-11-02T09:27:39Z

src/main/java/net/dv8tion/jda/api/events/thread/member/ThreadMemberLeaveEvent.java

 import net.dv8tion.jda.api.entities.ThreadMember;
 import net.dv8tion.jda.api.entities.channel.concrete.ThreadChannel;

 import javax.annotation.Nonnull;

-//TODO-v5: Docs
+/**
+ * Indicates that a {@link Member GuildMember} left a {@link ThreadChannel}.


Please stop using "GuildMember" everywhere, it looks like an actual type in the docs if you read this and only confuses the reader more.

…ThreadMemberEvent.java Co-authored-by: Florian Spieß <business@minn.dev>

src/main/java/net/dv8tion/jda/api/events/channel/update/ChannelUpdateTypeEvent.java

src/main/java/net/dv8tion/jda/api/events/channel/update/GenericChannelUpdateEvent.java

src/main/java/net/dv8tion/jda/api/events/thread/member/ThreadMemberLeaveEvent.java

…emberLeaveEvent.java Co-authored-by: Austin Keener <keeneraustin@yahoo.com>

…cChannelUpdateEvent.java Co-authored-by: Austin Keener <keeneraustin@yahoo.com>

Chew

I giveth and taketh apostrophes away

src/main/java/net/dv8tion/jda/api/entities/ThreadMember.java

src/main/java/net/dv8tion/jda/api/events/channel/update/ChannelUpdateArchiveTimestampEvent.java

src/main/java/net/dv8tion/jda/api/events/channel/update/ChannelUpdateArchivedEvent.java

...in/java/net/dv8tion/jda/api/events/channel/update/ChannelUpdateAutoArchiveDurationEvent.java

src/main/java/net/dv8tion/jda/api/events/channel/update/ChannelUpdateSlowmodeEvent.java

src/main/java/net/dv8tion/jda/api/events/channel/update/ChannelUpdateTopicEvent.java

src/main/java/net/dv8tion/jda/api/events/channel/update/ChannelUpdateTypeEvent.java

src/main/java/net/dv8tion/jda/api/events/channel/update/ChannelUpdateUserLimitEvent.java

src/main/java/net/dv8tion/jda/api/events/thread/member/ThreadMemberJoinEvent.java

Sanduhr32 · 2022-11-23T11:16:52Z

Makes no sense, that you take 2 ' away and add about 14 more of them.

MinnDevelopment · 2022-11-23T12:22:40Z

@Sanduhr32 The use of it's is just wrong grammar

https://www.merriam-webster.com/words-at-play/when-to-use-its-vs-its

DV8FromTheWorld

LGTM

Sanduhr32 added 2 commits October 22, 2022 21:26

Message#createThreadChannel() docs

3037557

ThreadEvent docs

64feaf6

MinnDevelopment added hacktoberfest-accepted type: documentation labels Oct 22, 2022

first pass on threadmember docs

b60b62f

DV8FromTheWorld reviewed Oct 23, 2022

View reviewed changes

remove flags from threadmember

e1b7e6e

MinnDevelopment added the type: breaking contains a backwards incompatible change label Oct 24, 2022

Sanduhr32 added 3 commits October 27, 2022 20:10

Merge branch 'master' into san-master

40d723b

# Conflicts: # src/main/java/net/dv8tion/jda/internal/entities/ThreadMemberImpl.java

better threadmember wording

9177cf7

start documenting v5 channel events

e369db8

DV8FromTheWorld reviewed Oct 28, 2022

View reviewed changes

Sanduhr32 and others added 10 commits October 30, 2022 01:41

Update src/main/java/net/dv8tion/jda/api/entities/ThreadMember.java

84c08b0

Co-authored-by: Austin Keener <keeneraustin@yahoo.com>

Update src/main/java/net/dv8tion/jda/api/entities/ThreadMember.java

25304f4

Co-authored-by: Austin Keener <keeneraustin@yahoo.com>

remove todo for isJoined() in ThreadChannel

9ba57b5

Merge remote-tracking branch 'SAN/master' into san-master

ff56ee8

docuemnt getUser() for thread members

31c58cd

remove todo for more channel type getters of GenericChannelEvent

bcf38b1

> that todo comment is outdated i think > getters should be fine already ~ Minn

some channel update events

a71b6da

Mark ForumChannel as a TopicChannelMixin

2789b35

all channel update events

6ed9cf3

Update src/main/java/net/dv8tion/jda/api/entities/channel/ChannelFiel…

209a665

…d.java Co-authored-by: Florian Spieß <business@minn.dev>

Sanduhr32 added 3 commits November 1, 2022 15:13

document GenericThreadMemberEvent better

d7ead73

include IllegalStateException in createThreadChannel() docs

4ce4186

Update IThreadContainer.java

18e4e41

MinnDevelopment reviewed Nov 2, 2022

View reviewed changes

Sanduhr32 and others added 2 commits November 3, 2022 12:22

Update src/main/java/net/dv8tion/jda/api/events/thread/member/Generic…

a6e163c

…ThreadMemberEvent.java Co-authored-by: Florian Spieß <business@minn.dev>

Update src/main/java/net/dv8tion/jda/api/events/thread/member/Generic…

8382ddc

…ThreadMemberEvent.java Co-authored-by: Florian Spieß <business@minn.dev>

Sanduhr32 added 2 commits November 4, 2022 13:37

reword docs

ec869b3

reword docs

2079aea

Sanduhr32 requested a review from MinnDevelopment November 4, 2022 12:40

reword docs

faafc75

Sanduhr32 requested review from DV8FromTheWorld and removed request for MinnDevelopment November 8, 2022 00:19

DV8FromTheWorld requested changes Nov 20, 2022

View reviewed changes

Sanduhr32 and others added 3 commits November 20, 2022 18:33

Update src/main/java/net/dv8tion/jda/api/events/thread/member/ThreadM…

005b4f6

…emberLeaveEvent.java Co-authored-by: Austin Keener <keeneraustin@yahoo.com>

Update src/main/java/net/dv8tion/jda/api/events/channel/update/Generi…

310d6f1

…cChannelUpdateEvent.java Co-authored-by: Austin Keener <keeneraustin@yahoo.com>

mention specific channel type updates in docs

a3dc974

Chew reviewed Nov 21, 2022

View reviewed changes

Sanduhr32 added 2 commits November 24, 2022 13:56

improve docs

c99c760

undo

8888e3d

Sanduhr32 requested a review from DV8FromTheWorld November 26, 2022 23:55

DV8FromTheWorld approved these changes Nov 27, 2022

View reviewed changes

MinnDevelopment merged commit b3479a1 into discord-jda:master Nov 27, 2022

renovate bot mentioned this pull request Apr 1, 2024

Update dependency net.dv8tion:JDA to v5.0.0-beta.21 - autoclosed emmaboecker/reputation-bot#3

Closed

1 task

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

More v5 documentation #2296

More v5 documentation #2296

Sanduhr32 commented Oct 22, 2022

Sanduhr32 commented Oct 26, 2022

Sanduhr32 commented Oct 30, 2022 •

edited

MinnDevelopment Nov 2, 2022

Sanduhr32 Nov 5, 2022

MinnDevelopment Nov 2, 2022

Sanduhr32 Nov 2, 2022

MinnDevelopment Nov 2, 2022

MinnDevelopment Nov 2, 2022

MinnDevelopment Nov 2, 2022

MinnDevelopment Nov 2, 2022

Chew left a comment

Sanduhr32 commented Nov 23, 2022

MinnDevelopment commented Nov 23, 2022 •

edited

DV8FromTheWorld left a comment

	* The interacting {@link ThreadMember} as a {@link Member GuildMember}.
	* The interacting {@link ThreadMember} as a {@link Member}.

	* @return The interacting {@link ThreadMember} as a {@link Member GuildMember}.
	* @return The interacting {@link ThreadMember} as a {@link Member}.

		* The joined {@link ThreadMember} as a {@link Member GuildMember}
		* @return The joined {@link ThreadMember} as a {@link Member GuildMember}

More v5 documentation #2296

More v5 documentation #2296

Conversation

Sanduhr32 commented Oct 22, 2022

Pull Request Etiquette

Changes

Description

Sanduhr32 commented Oct 26, 2022

Sanduhr32 commented Oct 30, 2022 • edited

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Chew left a comment

Choose a reason for hiding this comment

Sanduhr32 commented Nov 23, 2022

MinnDevelopment commented Nov 23, 2022 • edited

DV8FromTheWorld left a comment

Choose a reason for hiding this comment

Sanduhr32 commented Oct 30, 2022 •

edited

MinnDevelopment commented Nov 23, 2022 •

edited