Skip to content

fix: enum and docs typos #431

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.

Sign up for GitHub

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

Open
Bilal2453 wants to merge 1 commit into
base: master
Choose a base branch
from
Open

fix: enum and docs typos #431

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion libs/client/EventHandler.lua
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -533,7 +533,7 @@ end

function EventHandler.WEBHOOKS_UPDATE(d, client) -- webhook object is not provided
local guild = client._guilds:get(d.guild_id)
if not guild then return warning(client, 'Guild', d.guild_id, 'WEBHOOKS_UDPATE') end
if not guild then return warning(client, 'Guild', d.guild_id, 'WEBHOOKS_UPDATE') end
local channel = guild._text_channels:get(d.channel_id)
if not channel then return warning(client, 'TextChannel', d.channel_id, 'WEBHOOKS_UPDATE') end
return client:emit('webhooksUpdate', channel)
Expand Down
2 changes: 1 addition & 1 deletion libs/containers/AuditLogEntry.lua
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -209,7 +209,7 @@ function get.targetId(self)
return self._target_id
end

--[=[@p userId string The Snowflake ID of the user who commited the action.]=]
--[=[@p userId string The Snowflake ID of the user who committed the action.]=]
function get.userId(self)
return self._user_id
end
Expand Down
6 changes: 3 additions & 3 deletions libs/containers/Guild.lua
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -371,7 +371,7 @@ end
@t http
@p default_message_notifications number
@r boolean
@d Sets the guild's default notification setting. See the `notficationSetting`
@d Sets the guild's default notification setting. See the `notificationSetting`
enumeration for acceptable values.
]=]
function Guild:setNotificationSetting(default_message_notifications)
Expand Down Expand Up @@ -416,7 +416,7 @@ end
--[=[
@m setSystemChannel
@t http
@p id Channel-Id-Resolvable
@p id Channel-ID-Resolvable
@r boolean
@d Sets the guild's join message channel.
]=]
Expand Down Expand Up @@ -845,7 +845,7 @@ function get.verificationLevel(self)
return self._verification_level
end

--[=[@p notificationSetting number The guild's default notification setting. See the `notficationSetting`
--[=[@p notificationSetting number The guild's default notification setting. See the `notificationSetting`
enumeration for a human-readable representation.]=]
function get.notificationSetting(self)
return self._default_message_notifications
Expand Down
45 changes: 23 additions & 22 deletions libs/enums.lua
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -236,28 +236,29 @@ enums.messageFlag = enum {
}

enums.gatewayIntent = enum {
guilds = flag(0),
guildMembers = flag(1), -- privileged
guildModeration = flag(2),
guildEmojis = flag(3),
guildIntegrations = flag(4),
guildWebhooks = flag(5),
guildInvites = flag(6),
guildVoiceStates = flag(7),
guildPresences = flag(8), -- privileged
guildMessages = flag(9),
guildMessageReactions = flag(10),
guildMessageTyping = flag(11),
directMessage = flag(12),
directMessageRections = flag(13),
directMessageTyping = flag(14),
messageContent = flag(15), -- privileged
guildScheduledEvents = flag(16),
-- unused = flag(17),
-- unused = flag(18),
-- unused = flag(19),
autoModConfiguration = flag(20),
autoModExecution = flag(21),
guilds = flag(0),
guildMembers = flag(1), -- privileged
guildModeration = flag(2),
guildEmojis = flag(3),
guildIntegrations = flag(4),
guildWebhooks = flag(5),
guildInvites = flag(6),
guildVoiceStates = flag(7),
guildPresences = flag(8), -- privileged
guildMessages = flag(9),
guildMessageReactions = flag(10),
guildMessageTyping = flag(11),
directMessage = flag(12),
directMessageRections = flag(13), -- typo, deprecated
directMessageReactions = flag(13),
directMessageTyping = flag(14),
messageContent = flag(15), -- privileged
guildScheduledEvents = flag(16),
-- unused = flag(17),
-- unused = flag(18),
-- unused = flag(19),
autoModConfiguration = flag(20),
autoModExecution = flag(21),
}

enums.actionType = enum {
Expand Down
8 changes: 4 additions & 4 deletions libs/voice/VoiceConnection.lua
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -156,7 +156,7 @@ end
@m getBitrate
@t mem
@r nil
@d Returns the bitrate of the interal Opus encoder in bits per second (bps).
@d Returns the bitrate of the internal Opus encoder in bits per second (bps).
]=]
function VoiceConnection:getBitrate()
return self._encoder:get(opus.GET_BITRATE_REQUEST)
Expand All @@ -167,7 +167,7 @@ end
@t mem
@p bitrate number
@r nil
@d Sets the bitrate of the interal Opus encoder in bits per second (bps).
@d Sets the bitrate of the internal Opus encoder in bits per second (bps).
This should be between 8000 and 128000, inclusive.
]=]
function VoiceConnection:setBitrate(bitrate)
Expand All @@ -179,7 +179,7 @@ end
@m getComplexity
@t mem
@r number
@d Returns the complexity of the interal Opus encoder.
@d Returns the complexity of the internal Opus encoder.
]=]
function VoiceConnection:getComplexity()
return self._encoder:get(opus.GET_COMPLEXITY_REQUEST)
Expand All @@ -190,7 +190,7 @@ end
@t mem
@p complexity number
@r nil
@d Sets the complexity of the interal Opus encoder.
@d Sets the complexity of the internal Opus encoder.
This should be between 0 and 10, inclusive.
]=]
function VoiceConnection:setComplexity(complexity)
Expand Down