NetCord icon indicating copy to clipboard operation
NetCord copied to clipboard

Added documentation to GatewayIntents.cs, GatewayClient.cs and GatewayOpcodes.cs

Open Red-K0 opened this issue 1 year ago • 16 comments

Red-K0 avatar Apr 23 '24 19:04 Red-K0

Fixed the brace

Red-K0 avatar Apr 23 '24 19:04 Red-K0

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

KubaZ2 avatar Apr 23 '24 19:04 KubaZ2

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 avatar Apr 23 '24 19:04 Red-K0

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

Red-K0 avatar Apr 23 '24 19:04 Red-K0

I would remove the polls intents from this pr and move them to https://github.com/KubaZ2/NetCord/pull/18.

KubaZ2 avatar Apr 23 '24 19:04 KubaZ2

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

Red-K0 avatar Apr 23 '24 20:04 Red-K0

<see> tagged literally everything.

Red-K0 avatar Apr 23 '24 20:04 Red-K0

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

Red-K0 avatar Apr 24 '24 10:04 Red-K0

All bullet points converted to XML tags.

Red-K0 avatar Apr 24 '24 11:04 Red-K0

Covered pretty much all the comments so far.

Red-K0 avatar Apr 26 '24 12:04 Red-K0

All intents and their requirements/influences laid out in the docs, I'll add more I can find, but the bulk of them are ready.

Red-K0 avatar Apr 26 '24 12:04 Red-K0

Documented pretty much every required intent and its influence.

Red-K0 avatar Apr 26 '24 13:04 Red-K0

Sure, replaced them all.

Red-K0 avatar Apr 29 '24 04:04 Red-K0

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

Red-K0 avatar May 09 '24 00:05 Red-K0

Changed the documentation for it

Red-K0 avatar May 09 '24 18:05 Red-K0

We should probably try and finalize this soon

Red-K0 avatar May 10 '24 16:05 Red-K0

Added IPartialMessage changes.

Red-K0 avatar May 15 '24 04:05 Red-K0

Could you also add xml docs for ShardedGatewayClient?

KubaZ2 avatar May 17 '24 18:05 KubaZ2

Sure

Red-K0 avatar May 17 '24 18:05 Red-K0