Typo Fixes

disco/api/client.py

@@ -48,8 +48,8 @@ class APIClient(LoggingClass):
     is the only path to the API used within models/other interfaces, and it's
     the recommended path for all third-party users/implementations.
 
-    Args
-    ----
+    Parameters
+    ----------
     token : str
         The Discord authentication token (without prefixes) to be used for all
         HTTP requests.

disco/api/http.py

@@ -239,7 +239,7 @@ class HTTPClient(LoggingClass):
             to create the requestable route. The HTTPClient uses this to track
             rate limits as well.
         kwargs : dict
-            Keyword arguments that will be passed along to the requests library
+            Keyword arguments that will be passed along to the requests library.
 
         Raises
         ------
@@ -250,7 +250,7 @@ class HTTPClient(LoggingClass):
         Returns
         -------
         :class:`requests.Response`
-            The response object for the request
+            The response object for the request.
         """
         args = args or {}
         retry = kwargs.pop('retry_number', 0)
@@ -313,7 +313,7 @@ class HTTPClient(LoggingClass):
         client suspects is transient. Will always return a value between 500 and
         5000 milliseconds.
 
-        :returns: a random backoff in milliseconds
+        :returns: a random backoff in milliseconds.
         :rtype: float
         """
         return random.randint(500, 5000) / 1000.0

disco/api/ratelimit.py

@@ -26,7 +26,7 @@ class RouteState(LoggingClass):
         The number of remaining requests to the route before the rate limit will
         be hit, triggering a 429 response.
     reset_time : int
-        A unix epoch timestamp (in seconds) after which this rate limit is reset
+        A UNIX epoch timestamp (in seconds) after which this rate limit is reset.
     event : :class:`gevent.event.Event`
         An event that is used to block all requests while a route is in the
         cooldown stage.
@@ -45,7 +45,7 @@ class RouteState(LoggingClass):
     @property
     def chilled(self):
         """
-        Whether this route is currently being cooldown (aka waiting until reset_time).
+        Whether this route is currently being cooled-down (aka waiting until reset_time).
         """
         return self.event is not None
 
@@ -63,8 +63,8 @@ class RouteState(LoggingClass):
 
     def update(self, response):
         """
-        Updates this route with a given Requests response object. Its expected
-        the response has the required headers, however in the case it doesn't
+        Updates this route with a given Requests response object. It's expected
+        the response has the required headers, however in the case that it doesn't
         this function has no effect.
         """
         if 'X-RateLimit-Remaining' not in response.headers:
@@ -108,7 +108,7 @@ class RouteState(LoggingClass):
 
 class RateLimiter(LoggingClass):
     """
-    A in-memory store of ratelimit states for all routes we've ever called.
+    An in-memory store of ratelimit states for all routes we've ever called.
 
     Attributes
     ----------
@@ -124,7 +124,7 @@ class RateLimiter(LoggingClass):
         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 indefinitely until the route is finished being
-        cooled down. This function should be called before making a request to
+        cooled-down. This function should be called before making a request to
         the specified route.
 
         Parameters

disco/bot/bot.py

@@ -27,7 +27,7 @@ class BotConfig(Config):
     Attributes
     ----------
     levels : dict(snowflake, str)
-        Mapping of user IDs/role IDs to :class:`disco.bot.commands.CommandLevesls`
+        Mapping of user IDs/role IDs to :class:`disco.bot.commands.CommandLevels`
         which is used for the default commands_level_getter.
     plugins : list[string]
         List of plugin modules to load.
@@ -41,15 +41,15 @@ class BotConfig(Config):
         A dictionary describing what mention types can be considered a mention
         of the bot when using :attr:`commands_require_mention`. This dictionary
         can contain the following keys: `here`, `everyone`, `role`, `user`. When
-        a keys value is set to true, the mention type will be considered for
+        a key's value is set to true, the mention type will be considered for
         command parsing.
     commands_prefix : str
         A string prefix that is required for a message to be considered for
         command parsing.
     commands_allow_edit : bool
-        If true, the bot will reparse an edited message if it was the last sent
+        If true, the bot will re-parse an edited message if it was the last sent
         message in a channel, and did not previously trigger a command. This is
-        helpful for allowing edits to typod commands.
+        helpful for allowing edits to typed commands.
     commands_level_getter : function
         If set, a function which when given a GuildMember or User, returns the
         relevant :class:`disco.bot.commands.CommandLevels`.
@@ -70,9 +70,9 @@ class BotConfig(Config):
         Whether to enable the built-in Flask server which allows plugins to handle
         and route HTTP requests.
     http_host : str
-        The host string for the HTTP Flask server (if enabled)
+        The host string for the HTTP Flask server (if enabled).
     http_port : int
-        The port for the HTTP Flask server (if enabled)
+        The port for the HTTP Flask server (if enabled).
     """
     levels = {}
     plugins = []
@@ -109,7 +109,7 @@ class BotConfig(Config):
 class Bot(LoggingClass):
     """
     Disco's implementation of a simple but extendable Discord bot. Bots consist
-    of a set of plugins, and a Disco client.
+    of a set of plugins, and a Disco Client.
 
     Parameters
     ----------
@@ -126,7 +126,7 @@ class Bot(LoggingClass):
     config : `BotConfig`
         The bot configuration instance for this bot.
     plugins : dict(str, :class:`disco.bot.plugin.Plugin`)
-        Any plugins this bot has loaded
+        Any plugins this bot has loaded.
     """
     def __init__(self, client, config=None):
         self.client = client
@@ -205,8 +205,7 @@ class Bot(LoggingClass):
         Parameters
         ---------
         plugins : Optional[list(:class:`disco.bot.plugin.Plugin`)]
-            Any plugins to load after creating the new bot instance
-
+            Any plugins to load after creating the new bot instance.
         """
         from disco.cli import disco_main
         inst = cls(disco_main())
@@ -284,12 +283,12 @@ class Bot(LoggingClass):
         Parameters
         ---------
         msg : :class:`disco.types.message.Message`
-            The message object to parse and find matching commands for
+            The message object to parse and find matching commands for.
 
         Yields
         -------
         tuple(:class:`disco.bot.command.Command`, `re.MatchObject`)
-            All commands the message triggers
+            All commands the message triggers.
         """
         content = msg.content
 
@@ -382,7 +381,7 @@ class Bot(LoggingClass):
         Returns
         -------
         bool
-            whether any commands where successfully triggered by the message
+            Whether any commands where successfully triggered by the message.
         """
         commands = list(self.get_commands_for_message(
             self.config.commands_require_mention,
@@ -473,7 +472,7 @@ class Bot(LoggingClass):
             Plugin class to unload and remove.
         """
         if cls.__name__ not in self.plugins:
-            raise Exception('Cannot remove non-existant plugin: {}'.format(cls.__name__))
+            raise Exception('Cannot remove non-existent plugin: {}'.format(cls.__name__))
 
         ctx = {}
         self.plugins[cls.__name__].unload(ctx)

disco/bot/command.py

@@ -35,7 +35,7 @@ class CommandEvent(object):
     message information).
 
     Attributes
-    ---------
+    ----------
     command : :class:`Command`
         The command this event was created for (aka the triggered command).
     msg : :class:`disco.types.message.Message`
@@ -43,9 +43,9 @@ class CommandEvent(object):
     match : :class:`re.MatchObject`
         The regex match object for the command.
     name : str
-        The command name (or alias) which was triggered by the command
+        The command name (or alias) which was triggered by the command.
     args : list(str)
-        Arguments passed to the command
+        Arguments passed to the command.
     """
 
     def __init__(self, command, msg, match):
@@ -276,7 +276,7 @@ class Command(object):
         Returns
         -------
         bool
-            Whether this command was successful
+            Whether this command was successful.
         """
         parsed_kwargs = {}
 

disco/bot/parser.py

@@ -226,6 +226,6 @@ class ArgumentSet(object):
     @property
     def required_length(self):
         """
-        The number of required arguments to compile this set/specificaiton.
+        The number of required arguments to compile this set/specification.
         """
         return sum(i.true_count for i in self.args if i.required)

disco/bot/plugin.py

@@ -436,8 +436,8 @@ class Plugin(LoggingClass, PluginDeco):
         Registers a function to be called repeatedly, waiting for an interval
         duration.
 
-        Args
-        ----
+        Parameters
+        ----------
         func : function
             The function to be registered.
         interval : int
@@ -447,8 +447,8 @@ class Plugin(LoggingClass, PluginDeco):
         init : bool
             Whether to run this schedule once immediately, or wait for the first
             scheduled iteration.
-        kwargs: dict
-            kwargs which will be passed to executed `func`
+        kwargs : dict
+            kwargs which will be passed to executed `func`.
         """
         if kwargs is None:
             kwargs = {}

disco/cli.py

@@ -16,8 +16,8 @@ monkey.patch_all()
 parser = argparse.ArgumentParser()
 
 # Command line specific arguments
-parser.add_argument('--run-bot', help='run a disco bot on this client', action='store_true', default=False)
-parser.add_argument('--plugin', help='load plugins into the bot', nargs='*', default=[])
+parser.add_argument('--run-bot', help='Run a disco bot on this client', action='store_true', default=False)
+parser.add_argument('--plugin', help='Load plugins into the bot', nargs='*', default=[])
 parser.add_argument('--config', help='Configuration file', default=None)
 parser.add_argument('--shard-auto', help='Automatically run all shards', action='store_true', default=False)
 
@@ -29,7 +29,7 @@ parser.add_argument('--max-reconnects', help='Maximum reconnect attempts', defau
 parser.add_argument('--log-level', help='log level', default=None)
 parser.add_argument('--manhole', action='store_true', help='Enable the manhole', default=None)
 parser.add_argument('--manhole-bind', help='host:port for the manhole to bind too', default=None)
-parser.add_argument('--encoder', help='encoder for gateway data', default=None)
+parser.add_argument('--encoder', help='Encoder for gateway data', default=None)
 
 
 # Mapping of argument names to configuration overrides
@@ -53,7 +53,7 @@ def disco_main(run=False):
     Returns
     -------
     :class:`Client`
-        A new Client from the provided command line arguments
+        A new Client from the provided command line arguments.
     """
     from disco.client import Client, ClientConfig
     from disco.bot import Bot, BotConfig

disco/client.py

@@ -29,12 +29,12 @@ class ClientConfig(Config):
         Whether to enable subscription events (e.g. presence and typing).
     max_reconnects : int
         The maximum number of connection retries to make before giving up (0 = never give up).
-    log_level: str
+    log_level : str
         The logging level to use.
     manhole_enable : bool
         Whether to enable the manhole (e.g. console backdoor server) utility.
     manhole_bind : tuple(str, int)
-        A (host, port) combination which the manhole server will bind to (if its
+        A (host, port) combination which the manhole server will bind to (if it's
         enabled using :attr:`manhole_enable`).
     encoder : str
         The type of encoding to use for encoding/decoding data from websockets,
@@ -114,12 +114,12 @@ class Client(LoggingClass):
         """
         Updates the current clients presence.
 
-        Params
-        ------
+        Parameters
+        ----------
         status : `user.Status`
             The clients current status.
         game : `user.Game`
-            If passed, the game object to set for the users presence.
+            If passed, the game object to set for the user's presence.
         afk : bool
             Whether the client is currently afk.
         since : float

disco/gateway/events.py

@@ -127,7 +127,7 @@ class Ready(GatewayEvent):
     for bootstrapping the client's states.
 
     Attributes
-    -----
+    ----------
     version : int
         The gateway version.
     session_id : str
@@ -158,9 +158,9 @@ class GuildCreate(GatewayEvent):
     Sent when a guild is joined, or becomes available.
 
     Attributes
-    -----
+    ----------
     guild : :class:`disco.types.guild.Guild`
-        The guild being created (e.g. joined)
+        The guild being created (e.g. joined).
     unavailable : bool
         If false, this guild is coming online from a previously unavailable state,
         and if UNSET, this is a normal guild join event.
@@ -182,7 +182,7 @@ class GuildUpdate(GatewayEvent):
     Sent when a guild is updated.
 
     Attributes
-    -----
+    ----------
     guild : :class:`disco.types.guild.Guild`
         The updated guild object.
     """
@@ -193,7 +193,7 @@ class GuildDelete(GatewayEvent):
     Sent when a guild is deleted, left, or becomes unavailable.
 
     Attributes
-    -----
+    ----------
     id : snowflake
         The ID of the guild being deleted.
     unavailable : bool
@@ -217,7 +217,7 @@ class ChannelCreate(GatewayEvent):
     Sent when a channel is created.
 
     Attributes
-    -----
+    ----------
     channel : :class:`disco.types.channel.Channel`
         The channel which was created.
     """
@@ -229,7 +229,7 @@ class ChannelUpdate(ChannelCreate):
     Sent when a channel is updated.
 
     Attributes
-    -----
+    ----------
     channel : :class:`disco.types.channel.Channel`
         The channel which was updated.
     """
@@ -242,7 +242,7 @@ class ChannelDelete(ChannelCreate):
     Sent when a channel is deleted.
 
     Attributes
-    -----
+    ----------
     channel : :class:`disco.types.channel.Channel`
         The channel being deleted.
     """
@@ -253,7 +253,7 @@ class ChannelPinsUpdate(GatewayEvent):
     Sent when a channel's pins are updated.
 
     Attributes
-    -----
+    ----------
     channel_id : snowflake
         ID of the channel where pins where updated.
     last_pin_timestap : datetime
@@ -269,7 +269,7 @@ class GuildBanAdd(GatewayEvent):
     Sent when a user is banned from a guild.
 
     Attributes
-    -----
+    ----------
     guild_id : snowflake
         The ID of the guild the user is being banned from.
     user : :class:`disco.types.user.User`
@@ -289,7 +289,7 @@ class GuildBanRemove(GuildBanAdd):
     Sent when a user is unbanned from a guild.
 
     Attributes
-    -----
+    ----------
     guild_id : snowflake
         The ID of the guild the user is being unbanned from.
     user : :class:`disco.types.user.User`
@@ -306,11 +306,11 @@ class GuildEmojisUpdate(GatewayEvent):
     Sent when a guild's emojis are updated.
 
     Attributes
-    -----
+    ----------
     guild_id : snowflake
         The ID of the guild the emojis are being updated in.
     emojis : list[:class:`disco.types.guild.Emoji`]
-        The new set of emojis for the guild
+        The new set of emojis for the guild.
     """
     guild_id = Field(snowflake)
     emojis = ListField(GuildEmoji)
@@ -321,7 +321,7 @@ class GuildIntegrationsUpdate(GatewayEvent):
     Sent when a guild's integrations are updated.
 
     Attributes
-    -----
+    ----------
     guild_id : snowflake
         The ID of the guild integrations where updated in.
     """
@@ -333,7 +333,7 @@ class GuildMembersChunk(GatewayEvent):
     Sent in response to a member's chunk request.
 
     Attributes
-    -----
+    ----------
     guild_id : snowflake
         The ID of the guild this member chunk is for.
     members : list[:class:`disco.types.guild.GuildMember`]
@@ -353,7 +353,7 @@ class GuildMemberAdd(GatewayEvent):
     Sent when a user joins a guild.
 
     Attributes
-    -----
+    ----------
     member : :class:`disco.types.guild.GuildMember`
         The member that has joined the guild.
     """
@@ -365,7 +365,7 @@ class GuildMemberRemove(GatewayEvent):
     Sent when a user leaves a guild (via leaving, kicking, or banning).
 
     Attributes
-    -----
+    ----------
     guild_id : snowflake
         The ID of the guild the member left from.
     user : :class:`disco.types.user.User`
@@ -385,7 +385,7 @@ class GuildMemberUpdate(GatewayEvent):
     Sent when a guilds member is updated.
 
     Attributes
-    -----
+    ----------
     member : :class:`disco.types.guild.GuildMember`
         The member being updated
     """
@@ -398,7 +398,7 @@ class GuildRoleCreate(GatewayEvent):
     Sent when a role is created.
 
     Attributes
-    -----
+    ----------
     guild_id : snowflake
         The ID of the guild where the role was created.
     role : :class:`disco.types.guild.Role`
@@ -417,7 +417,7 @@ class GuildRoleUpdate(GuildRoleCreate):
     Sent when a role is updated.
 
     Attributes
-    -----
+    ----------
     guild_id : snowflake
         The ID of the guild where the role was created.
     role : :class:`disco.types.guild.Role`
@@ -434,7 +434,7 @@ class GuildRoleDelete(GatewayEvent):
     Sent when a role is deleted.
 
     Attributes
-    -----
+    ----------
     guild_id : snowflake
         The ID of the guild where the role is being deleted.
     role_id : snowflake
@@ -454,7 +454,7 @@ class MessageCreate(GatewayEvent):
     Sent when a message is created.
 
     Attributes
-    -----
+    ----------
     message : :class:`disco.types.message.Message`
         The message being created.
     guild_id : snowflake
@@ -469,7 +469,7 @@ class MessageUpdate(MessageCreate):
     Sent when a message is updated/edited.
 
     Attributes
-    -----
+    ----------
     message : :class:`disco.types.message.Message`
         The message being updated.
     guild_id : snowflake
@@ -483,7 +483,7 @@ class MessageDelete(GatewayEvent):
     Sent when a message is deleted.
 
     Attributes
-    -----
+    ----------
     id : snowflake
         The ID of message being deleted.
     channel_id : snowflake
@@ -509,7 +509,7 @@ class MessageDeleteBulk(GatewayEvent):
     Sent when multiple messages are deleted from a channel.
 
     Attributes
-    -----
+    ----------
     guild_id : snowflake
         The guild the messages are being deleted in.
     channel_id : snowflake
@@ -536,7 +536,7 @@ class PresenceUpdate(GatewayEvent):
     Sent when a user's presence is updated.
 
     Attributes
-    -----
+    ----------
     presence : :class:`disco.types.user.Presence`
         The updated presence object.
     guild_id : snowflake
@@ -557,7 +557,7 @@ class TypingStart(GatewayEvent):
     Sent when a user begins typing in a channel.
 
     Attributes
-    -----
+    ----------
     guild_id : snowflake
         The ID of the guild where the user is typing.
     channel_id : snowflake
@@ -579,7 +579,7 @@ class VoiceStateUpdate(GatewayEvent):
     Sent when a users voice state changes.
 
     Attributes
-    -----
+    ----------
     state : :class:`disco.models.voice.VoiceState`
         The voice state which was updated.
     """
@@ -590,7 +590,7 @@ class VoiceServerUpdate(GatewayEvent):
     Sent when a voice server is updated.
 
     Attributes
-    -----
+    ----------
     token : str
         The token for the voice server.
     endpoint : str
@@ -608,7 +608,7 @@ class WebhooksUpdate(GatewayEvent):
     Sent when a channels webhooks are updated.
 
     Attributes
-    -----
+    ----------
     channel_id : snowflake
         The channel ID this webhooks update is for.
     guild_id : snowflake

disco/state.py

@@ -19,11 +19,11 @@ class StackMessage(namedtuple('StackMessage', ['id', 'channel_id', 'author_id'])
     Attributes
     ---------
     id : snowflake
-        the id of the message
+        The id of the message.
     channel_id : snowflake
-        the id of the channel this message was sent in
+        The id of the channel this message was sent in.
     author_id : snowflake
-        the id of the author of this message
+        The id of the author of this message.
     """
 
 
@@ -40,8 +40,8 @@ class StateConfig(Config):
 
         Message tracking is implemented using a deque and a namedtuple, meaning
         it should generally not have a high impact on memory, however users who
-        find they do not need and may be experiencing memory pressure can disable
-        this feature entirely using this attribute.
+        find that they do not need and may be experiencing memory pressure can
+        disable this feature entirely using this attribute.
     track_messages_size : int
         The size of the messages deque for each channel. This value can be used
         to calculate the total number of possible `StackMessage` objects kept in
@@ -50,7 +50,7 @@ class StateConfig(Config):
     sync_guild_members : bool
         If true, guilds will be automatically synced when they are initially loaded
         or joined. Generally this setting is OK for smaller bots, however bots in over
-        50 guilds will notice this operation can take a while to complete and may want
+        50 guilds will notice this operation can take a while to complete, and may want
         to batch requests using the underlying `GatewayClient.request_guild_members`
         interface.
     """
@@ -69,27 +69,27 @@ class State(object):
     Attributes
     ----------
     EVENTS : list(str)
-        A list of all events the State object binds to
+        A list of all events the State object binds to.
     client : `disco.client.Client`
-        The Client instance this state is attached to
+        The Client instance this state is attached to.
     config : `StateConfig`
-        The configuration for this state instance
+        The configuration for this state instance.
     me : `User`
-        The currently logged in user
+        The currently logged in user.
     dms : dict(snowflake, `Channel`)
-        Mapping of all known DM Channels
+        Mapping of all known DM Channels.
     guilds : dict(snowflake, `Guild`)
-        Mapping of all known/loaded Guilds
+        Mapping of all known/loaded Guilds.
     channels : dict(snowflake, `Channel`)
-        Weak mapping of all known/loaded Channels
+        Weak mapping of all known/loaded Channels.
     users : dict(snowflake, `User`)
-        Weak mapping of all known/loaded Users
+        Weak mapping of all known/loaded Users.
     voice_clients : dict(str, 'VoiceClient')
-        Weak mapping of all known voice clients
+        Weak mapping of all known voice clients.
     voice_states : dict(str, `VoiceState`)
-        Weak mapping of all known/active Voice States
+        Weak mapping of all known/active Voice States.
     messages : Optional[dict(snowflake, deque)]
-        Mapping of channel ids to deques containing `StackMessage` objects
+        Mapping of channel ids to deques containing `StackMessage` objects.
     """
     EVENTS = [
         'Ready', 'GuildCreate', 'GuildUpdate', 'GuildDelete', 'GuildMemberAdd', 'GuildMemberRemove',

disco/types/channel.py

@@ -43,13 +43,13 @@ class PermissionOverwrite(ChannelSubType):
     Attributes
     ----------
     id : snowflake
-        The overwrite ID
+        The overwrite ID.
     type : :const:`disco.types.channel.PermissionsOverwriteType`
-        The overwrite type
+        The overwrite type.
     allow : :class:`disco.types.permissions.PermissionValue`
-        All allowed permissions
+        All allowed permissions.
     deny : :class:`disco.types.permissions.PermissionValue`
-        All denied permissions
+        All denied permissions.
     """
     id = Field(snowflake)
     type = Field(enum(PermissionOverwriteType))
@@ -265,7 +265,7 @@ class Channel(SlottedModel, Permissible):
         Returns
         -------
         `Message`
-            The fetched message
+            The fetched message.
         """
         return self.client.api.channels_messages_get(self.id, to_snowflake(message))
 
@@ -304,8 +304,8 @@ class Channel(SlottedModel, Permissible):
         """
         Pins the given message to the channel.
 
-        Params
-        ------
+        Parameters
+        ----------
         message : `Message`|snowflake
             The message or message ID to pin.
         """
@@ -315,8 +315,8 @@ class Channel(SlottedModel, Permissible):
         """
         Unpins the given message from the channel.
 
-        Params
-        ------
+        Parameters
+        ----------
         message : `Message`|snowflake
             The message or message ID to pin.
         """
@@ -373,8 +373,8 @@ class Channel(SlottedModel, Permissible):
         """
         Deletes a single message from this channel.
 
-        Args
-        ----
+        Parameters
+        ----------
         message : snowflake|`Message`
             The message to delete.
         """
@@ -386,8 +386,8 @@ class Channel(SlottedModel, Permissible):
         Deletes a set of messages using the correct API route based on the number
         of messages passed.
 
-        Args
-        ----
+        Parameters
+        ----------
         messages : list(snowflake|`Message`)
             List of messages (or message ids) to delete. All messages must originate
             from this channel.

disco/types/guild.py

@@ -199,8 +199,8 @@ class GuildMember(SlottedModel):
         """
         Bans the member from the guild.
 
-        Args
-        ----
+        Parameters
+        ----------
         delete_message_days : int
             The number of days to retroactively delete messages for.
         """
@@ -216,8 +216,8 @@ class GuildMember(SlottedModel):
         """
         Sets the member's nickname (or clears it if None).
 
-        Args
-        ----
+        Parameters
+        ----------
         nickname : Optional[str]
             The nickname (or none to reset) to set.
         """

disco/types/message.py

@@ -482,8 +482,8 @@ class Message(SlottedModel):
         """
         Edit this message.
 
-        Args
-        ----
+        Parameters
+        ----------
         content : str
             The new edited contents of the message.
 
@@ -621,8 +621,8 @@ class Message(SlottedModel):
         """
         Replaces user and role mentions with the result of a given lambda/function.
 
-        Args
-        ----
+        Parameters
+        ----------
         user_replace : function
             A function taking a single argument, the user object mentioned, and
             returning a valid string.

disco/util/functional.py

@@ -25,8 +25,8 @@ def chunks(obj, size):
     """
     Splits a list into sized chunks.
 
-    Args
-    ----
+    Parameters
+    ----------
     obj : list
         List to split up.
     size : int