Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Added documentation to GatewayIntents.cs, GatewayClient.cs, ShardedGatewayClient.cs and GatewayOpcodes.cs #20

Merged
merged 38 commits into from
May 17, 2024

Conversation

Red-K0
Copy link
Contributor

@Red-K0 Red-K0 commented Apr 23, 2024

No description provided.

…well as detailed documentation for all intents.
NetCord/Gateway/GatewayIntents.cs Outdated Show resolved Hide resolved
Co-authored-by: Kuba_Z2 <[email protected]>
@Red-K0
Copy link
Contributor Author

Red-K0 commented Apr 23, 2024

Fixed the brace

@KubaZ2
Copy link
Member

KubaZ2 commented Apr 23, 2024

What about using the see tag to mention events from GatewayClient instead of using the Discord raw event names?

@Red-K0
Copy link
Contributor Author

Red-K0 commented Apr 23, 2024

What about using the see tag to mention events from GatewayClient instead of using the Discord raw event names?

I thought about it, but I couldn't seem to find any centralized way to reference them all without having to tag random members across NetCord. If it does exist, I'll use it though. (I could also add one)

@Red-K0
Copy link
Contributor Author

Red-K0 commented Apr 23, 2024

To clarify on my last comment, I was referring to newer events such as polls.

@KubaZ2
Copy link
Member

KubaZ2 commented Apr 23, 2024

I would remove the polls intents from this pr and move them to #18.

@Red-K0
Copy link
Contributor Author

Red-K0 commented Apr 23, 2024

Sure, moving them after I update the see tags then.

@Red-K0
Copy link
Contributor Author

Red-K0 commented Apr 23, 2024

<see> tagged literally everything.

@Red-K0 Red-K0 requested a review from KubaZ2 April 23, 2024 20:36
@Red-K0
Copy link
Contributor Author

Red-K0 commented Apr 24, 2024

Added more documentation in the meantime, all events in GatewayClient should be covered now.

@Red-K0
Copy link
Contributor Author

Red-K0 commented Apr 24, 2024

All bullet points converted to XML tags.

Copy link
Member

@KubaZ2 KubaZ2 left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

  • We should name guild members as guild users because NetCord's representation of a guild member is the GuildUser
  • I think that all gateway events should have required intents specified.
  • Some intents, like GuildPresences influence on other behaviours and I think that they should be documented for intents too.

NetCord/Gateway/GatewayClient.cs Outdated Show resolved Hide resolved
NetCord/Gateway/GatewayClient.cs Outdated Show resolved Hide resolved
NetCord/Gateway/GatewayClient.cs Show resolved Hide resolved
NetCord/Gateway/GatewayClient.cs Show resolved Hide resolved
NetCord/Gateway/GatewayClient.cs Outdated Show resolved Hide resolved
NetCord/Gateway/GatewayClient.cs Outdated Show resolved Hide resolved
NetCord/Gateway/GatewayClient.cs Outdated Show resolved Hide resolved
NetCord/Gateway/GatewayClient.cs Outdated Show resolved Hide resolved
NetCord/Gateway/GatewayClient.cs Outdated Show resolved Hide resolved
NetCord/Gateway/GatewayIntents.cs Outdated Show resolved Hide resolved
@Red-K0
Copy link
Contributor Author

Red-K0 commented Apr 26, 2024

Documented pretty much every required intent and its influence.

Copy link
Contributor Author

@Red-K0 Red-K0 left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Pretty much everything is done now

NetCord/Gateway/GatewayClient.cs Outdated Show resolved Hide resolved
NetCord/Gateway/GatewayClient.cs Outdated Show resolved Hide resolved
NetCord/Gateway/GatewayClient.cs Outdated Show resolved Hide resolved
NetCord/Gateway/GatewayClient.cs Outdated Show resolved Hide resolved
NetCord/Gateway/GatewayClient.cs Outdated Show resolved Hide resolved
NetCord/Gateway/GatewayClient.cs Outdated Show resolved Hide resolved
NetCord/Gateway/GatewayClient.cs Show resolved Hide resolved
NetCord/Gateway/GatewayClient.cs Outdated Show resolved Hide resolved
NetCord/Gateway/GatewayClient.cs Outdated Show resolved Hide resolved
NetCord/Gateway/GatewayClient.cs Outdated Show resolved Hide resolved
Copy link
Member

@KubaZ2 KubaZ2 left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Could you replace discord with Discord?

@Red-K0
Copy link
Contributor Author

Red-K0 commented Apr 29, 2024

Sure, replaced them all.

NetCord/Gateway/GatewayClient.cs Outdated Show resolved Hide resolved
NetCord/Gateway/GatewayClient.cs Outdated Show resolved Hide resolved
@Red-K0
Copy link
Contributor Author

Red-K0 commented May 9, 2024

Instead of being pedantic about it, added the suggestion, but fixed the casing of The to the.

@Red-K0
Copy link
Contributor Author

Red-K0 commented May 9, 2024

Changed the documentation for it

@Red-K0
Copy link
Contributor Author

Red-K0 commented May 10, 2024

We should probably try and finalize this soon

@Red-K0
Copy link
Contributor Author

Red-K0 commented May 15, 2024

Added IPartialMessage changes.

@KubaZ2
Copy link
Member

KubaZ2 commented May 17, 2024

Could you also add xml docs for ShardedGatewayClient?

@Red-K0
Copy link
Contributor Author

Red-K0 commented May 17, 2024

Sure

@Red-K0 Red-K0 changed the title Added documentation to GatewayIntents.cs, GatewayClient.cs and GatewayOpcodes.cs Added documentation to GatewayIntents.cs, GatewayClient.cs, ShardedGatewayClient.cs and GatewayOpcodes.cs May 17, 2024
@KubaZ2 KubaZ2 merged commit 17790ac into NetCordDev:alpha May 17, 2024
1 check passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants