Skip to content
This repository has been archived by the owner on Aug 1, 2021. It is now read-only.

Commit

Permalink
Minor spelling fixes (#4)
Browse files Browse the repository at this point in the history
* Minor spelling fixes

* Minor spelling fixes

* Minor spelling fixes

* Minor spelling fixes

* Minor spelling fixes

* Minor spelling fixes

* Minor spelling fixes
  • Loading branch information
Wolfiri authored and b1naryth1ef committed Oct 9, 2016
1 parent d8bba96 commit e80dcec
Show file tree
Hide file tree
Showing 7 changed files with 32 additions and 32 deletions.
6 changes: 3 additions & 3 deletions disco/api/ratelimit.py
Original file line number Diff line number Diff line change
Expand Up @@ -114,7 +114,7 @@ def check(self, route, timeout=None):
"""
Checks whether a given route can be called. This function will return
immediately if no rate-limit cooldown is being imposed for the given
route, or will wait indefinently (unless timeout is specified) until
route, or will wait indefinitely (unless timeout is specified) until
the route is finished being cooled down. This function should be called
before making a request to the specified route.
Expand All @@ -123,8 +123,8 @@ def check(self, route, timeout=None):
route : tuple(HTTPMethod, str)
The route that will be checked.
timeout : Optional[int]
A timeout after which we'll give up waiting for a routes cooldown
to expire, and immedietly return.
A timeout after which we'll give up waiting for a route's cooldown
to expire, and immediately return.
Returns
-------
Expand Down
6 changes: 3 additions & 3 deletions disco/bot/command.py
Original file line number Diff line number Diff line change
Expand Up @@ -77,7 +77,7 @@ def author(self):
class CommandError(Exception):
"""
An exception which is thrown when the arguments for a command are invalid,
or don't match the commands specifications.
or don't match the command's specifications.
"""


Expand Down Expand Up @@ -151,7 +151,7 @@ def _f(ctx, i):
@cached_property
def compiled_regex(self):
"""
A compiled version of this commands regex
A compiled version of this command's regex
"""
return re.compile(self.regex)

Expand Down Expand Up @@ -179,7 +179,7 @@ def execute(self, event):
Returns
-------
bool
Whether this command was sucessful
Whether this command was successful
"""
if len(event.args) < self.args.required_length:
raise CommandError('{} requires {} arguments (passed {})'.format(
Expand Down
12 changes: 6 additions & 6 deletions disco/gateway/events.py
Original file line number Diff line number Diff line change
Expand Up @@ -87,7 +87,7 @@ def deco(cls):
class Ready(GatewayEvent):
"""
Sent after the initial gateway handshake is complete. Contains data required
for bootstrapping the clients states.
for bootstrapping the client's states.
"""
version = Field(int, alias='v')
session_id = Field(str)
Expand Down Expand Up @@ -151,7 +151,7 @@ class ChannelDelete(ChannelCreate):

class ChannelPinsUpdate(GatewayEvent):
"""
Sent when a channels pins are updated.
Sent when a channel's pins are updated.
"""
channel_id = Field(snowflake)
last_pin_timestamp = Field(int)
Expand All @@ -175,21 +175,21 @@ class GuildBanRemove(GuildBanAdd):

class GuildEmojisUpdate(GatewayEvent):
"""
Sent when a guilds emojis are updated.
Sent when a guild's emojis are updated.
"""
pass


class GuildIntegrationsUpdate(GatewayEvent):
"""
Sent when a guilds integrations are updated.
Sent when a guild's integrations are updated.
"""
pass


class GuildMembersChunk(GatewayEvent):
"""
Sent in response to a members chunk request.
Sent in response to a member's chunk request.
"""
guild_id = Field(snowflake)
members = Field(listof(GuildMember))
Expand Down Expand Up @@ -275,7 +275,7 @@ class MessageDeleteBulk(GatewayEvent):
@wraps_model(Presence)
class PresenceUpdate(GatewayEvent):
"""
Sent when a users presence is updated.
Sent when a user's presence is updated.
"""
guild_id = Field(snowflake)
roles = Field(listof(snowflake))
Expand Down
4 changes: 2 additions & 2 deletions disco/state.py
Original file line number Diff line number Diff line change
Expand Up @@ -57,9 +57,9 @@ class State(object):
Attributes
----------
EVENTS : list(str)
A list of all events the State object binds too.
A list of all events the State object binds to
client : :class:`disco.client.Client`
The Client instance this state is attached too
The Client instance this state is attached to
config : :class:`StateConfig`
The configuration for this state instance
me : :class:`disco.types.user.User`
Expand Down
8 changes: 4 additions & 4 deletions disco/types/channel.py
Original file line number Diff line number Diff line change
Expand Up @@ -63,13 +63,13 @@ class Channel(Model, Permissible):
guild_id : Optional[snowflake]
The guild id this channel is part of.
name : str
The channels name.
The channel's name.
topic : str
The channels topic.
The channel's topic.
position : int
The channels position.
The channel's position.
bitrate : int
The channels bitrate.
The channel's bitrate.
recipients: list(:class:`disco.types.user.User`)
Members of this channel (if this is a DM channel).
type : :const:`ChannelType`
Expand Down
24 changes: 12 additions & 12 deletions disco/types/guild.py
Original file line number Diff line number Diff line change
Expand Up @@ -102,7 +102,7 @@ class GuildMember(Model):
mute : bool
Whether this member is server voice-muted.
deaf : bool
Whether this member is server voice-deafend.
Whether this member is server voice-deafened.
joined_at : datetime
When this user joined the guild.
roles : list(snowflake)
Expand All @@ -122,7 +122,7 @@ def get_voice_state(self):
-------
Optional[:class:`disco.types.voice.VoiceState`]
Returns the voice state for the member if they are currently connected
to the guilds voice server.
to the guild's voice server.
"""
return self.guild.get_voice_state(self)

Expand All @@ -145,7 +145,7 @@ def ban(self, delete_message_days=0):

def set_nickname(self, nickname=None):
"""
Sets the members nickname (or clears it if None).
Sets the member's nickname (or clears it if None).
Args
----
Expand Down Expand Up @@ -195,33 +195,33 @@ class Guild(Model, Permissible):
embed_channel_id : snowflake
The id of the embed channel.
name : str
Guilds name.
Guild's name.
icon : str
Guilds icon (as PNG binary data).
Guild's icon (as PNG binary data).
splash : str
Guilds splash image (as PNG binary data).
Guild's splash image (as PNG binary data).
region : str
Voice region.
afk_timeout : int
Delay after which users are automatically moved to the afk channel.
embed_enabled : bool
Whether the guilds embed is enabled.
Whether the guild's embed is enabled.
verification_level : int
The verification level used by the guild.
mfa_level : int
The MFA level used by the guild.
features : list(str)
Extra features enabled for this guild.
members : dict(snowflake, :class:`GuildMember`)
All of the guilds members.
All of the guild's members.
channels : dict(snowflake, :class:`disco.types.channel.Channel`)
All of the guilds channels.
All of the guild's channels.
roles : dict(snowflake, :class:`Role`)
All of the guilds roles.
All of the guild's roles.
emojis : dict(snowflake, :class:`Emoji`)
All of the guilds emojis.
All of the guild's emojis.
voice_states : dict(str, :class:`disco.types.voice.VoiceState`)
All of the guilds voice states.
All of the guild's voice states.
"""
id = Field(snowflake)
owner_id = Field(snowflake)
Expand Down
4 changes: 2 additions & 2 deletions disco/types/invite.py
Original file line number Diff line number Diff line change
Expand Up @@ -19,13 +19,13 @@ class Invite(Model):
channel : :class:`disco.types.channel.Channel`
The channel this invite is for.
max_age : int
The time after this invites creation at which it expires.
The time after this invite's creation at which it expires.
max_uses : int
The maximum number of uses.
uses : int
The current number of times the invite was used.
temporary : bool
Whether this invite only grants temporary memborship.
Whether this invite only grants temporary membership.
created_at : datetime
When this invite was created.
"""
Expand Down

0 comments on commit e80dcec

Please sign in to comment.