Skip to content

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

Merged
KubaZ2 merged 38 commits into
NetCordDev:alphafrom
Red-K0:alpha
May 17, 2024
Merged

Added documentation to GatewayIntents.cs, GatewayClient.cs, ShardedGatewayClient.cs and GatewayOpcodes.cs#20
KubaZ2 merged 38 commits into
NetCordDev:alphafrom
Red-K0:alpha

Conversation

@Red-K0

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

Copy link
Copy Markdown
Contributor

No description provided.

…well as detailed documentation for all intents.
Comment thread NetCord/Gateway/GatewayIntents.cs Outdated
Co-authored-by: Kuba_Z2 <77853483+KubaZ2@users.noreply.github.com>
@Red-K0

Red-K0 commented Apr 23, 2024

Copy link
Copy Markdown
Contributor Author

Fixed the brace

@KubaZ2

KubaZ2 commented Apr 23, 2024

Copy link
Copy Markdown
Member

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

@Red-K0

Red-K0 commented Apr 23, 2024

Copy link
Copy Markdown
Contributor Author

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

Red-K0 commented Apr 23, 2024

Copy link
Copy Markdown
Contributor Author

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

@KubaZ2

KubaZ2 commented Apr 23, 2024

Copy link
Copy Markdown
Member

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

@Red-K0

Red-K0 commented Apr 23, 2024

Copy link
Copy Markdown
Contributor Author

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

@Red-K0

Red-K0 commented Apr 23, 2024

Copy link
Copy Markdown
Contributor Author

<see> tagged literally everything.

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

Red-K0 commented Apr 24, 2024

Copy link
Copy Markdown
Contributor Author

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

Comment thread NetCord/Gateway/GatewayIntents.cs Outdated
@Red-K0

Red-K0 commented Apr 24, 2024

Copy link
Copy Markdown
Contributor Author

All bullet points converted to XML tags.

@KubaZ2 KubaZ2 left a comment

Copy link
Copy Markdown
Member

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.

Comment thread NetCord/Gateway/GatewayClient.cs Outdated
Comment thread NetCord/Gateway/GatewayClient.cs Outdated
Comment thread NetCord/Gateway/GatewayClient.cs
Comment thread NetCord/Gateway/GatewayClient.cs
Comment thread NetCord/Gateway/GatewayClient.cs Outdated
Comment thread NetCord/Gateway/GatewayClient.cs Outdated
Comment thread NetCord/Gateway/GatewayClient.cs Outdated
Comment thread NetCord/Gateway/GatewayClient.cs Outdated
Comment thread NetCord/Gateway/GatewayClient.cs Outdated
Comment thread NetCord/Gateway/GatewayIntents.cs Outdated
Comment thread NetCord/Gateway/GatewayClient.cs Outdated
Comment thread NetCord/Gateway/GatewayClient.cs Outdated
@Red-K0

Red-K0 commented May 9, 2024

Copy link
Copy Markdown
Contributor Author

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

Comment thread NetCord/Gateway/GatewayClient.cs Outdated
@Red-K0

Red-K0 commented May 9, 2024

Copy link
Copy Markdown
Contributor Author

Changed the documentation for it

@Red-K0

Red-K0 commented May 10, 2024

Copy link
Copy Markdown
Contributor Author

We should probably try and finalize this soon

@Red-K0

Red-K0 commented May 15, 2024

Copy link
Copy Markdown
Contributor Author

Added IPartialMessage changes.

@KubaZ2

KubaZ2 commented May 17, 2024

Copy link
Copy Markdown
Member

Could you also add xml docs for ShardedGatewayClient?

@Red-K0

Red-K0 commented May 17, 2024

Copy link
Copy Markdown
Contributor Author

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
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