Skip to content

docs: add clarification for the permission needed for GuildBanAdd and GuildBanRemove#309

Open
kshitijanurag wants to merge 1 commit intoNetCordDev:alphafrom
kshitijanurag:patch-1
Open

docs: add clarification for the permission needed for GuildBanAdd and GuildBanRemove#309
kshitijanurag wants to merge 1 commit intoNetCordDev:alphafrom
kshitijanurag:patch-1

Conversation

@kshitijanurag
Copy link
Copy Markdown

Add clarification about the permission needed for receiving the GuildBanAdd and GuildBanRemove gateway events.

Discord API Docs Reference: discord/discord-api-docs#7948

@Mewyk
Copy link
Copy Markdown

Mewyk commented Mar 31, 2026

Doesn't follow the existing xml documentation patterns for this file (should be in remarks). I also believe this specific information should be properly placed elsewhere.

@kshitijanurag
Copy link
Copy Markdown
Author

Remark about permission for GuildAuditLogEntryCreate is also mentioned in summary so it seems to be consistent and follows the XML doc pattern.

/// The inner payload is an <see cref="AuditLogEntry"/> object. This event is only sent to bots with the <see cref="Permissions.ViewAuditLog"/> permission.<br/>

@Mewyk
Copy link
Copy Markdown

Mewyk commented Mar 31, 2026

I do agree that there are a few other inconsistencies in that file as it currently stands, which would make that fine. However, that stuff needs to be cleaned up, so that reasoning holds no weight here.

The bigger issue is visibility for the specific "clarification" as a whole for the main purposes of XML documentation. If you put it in the gateway client instead of the permission file, then when someone autocompletes/selects that permission symbol in an IDE, no one is going to see that specific remark because it's in gateway client.

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