documentation

Author: ovv

docs/configuration.rst

@@ -55,8 +55,8 @@ A basic configuration will look like this:
     plugin2:
         ...
 
-Plugins must be importable python modules defining the :ref:`references_hook`.
-See :ref:`writing_plugins` for more information.
+Plugins must be importable python modules. See :ref:`writing_plugins` for more
+information.
 
 .. _conf_starting_priority:
 
@@ -67,9 +67,8 @@ Plugins can depend on other plugins. You can ensure a startup order by setting
 a startup priority. By default all plugins have a priority of 50. Plugins with
 a higher priority will start before the one with a lower priority.
 
-If multiple plugins have the same priority they will start simultaneously.
-
-A priority of 0 or false will disable the plugin.
+If multiple plugins have the same priority they will start simultaneously. A
+priority of 0 or false will disable the plugin.
 
 .. code-block:: yaml
 
@@ -92,7 +91,7 @@ Each plugin should define his own logger. The core logger is :code:`sirbot.core`
 Import
 ------
 
-To use Sir-bot-a-lot in a project:
+To use Sir Bot-a-lot in a project:
 
 .. code-block:: python
 

docs/index.rst

@@ -13,17 +13,16 @@ The uses of bots are nearly endless and come in all shapes and sizes.
 They can handle Slack shenanigans, monitor the status of a crypto-currency,
 or become your personal assistant.
 
-Sir-bot-a-lot aims to be a framework to ease the creation of new and innovating
-bot for you and your team while keeping everything as simple as possible. It is
-build onto a plugin system that allow inter-connection with as much service as
-you like.
+Sir Bot-a-lot is a framework built to ease the creation of new and innovating
+bot for you and your team while keeping everything as simple as possible. It use
+a plugin system that allow inter-connection with as much service as you like.
 
 This project is maintained by the `pyslackers`_ community.
 Want to join? `Get an invite`_ !
 
 .. note::
 
-    The core sir-bot-a-lot module does **NOTHING** without plugins.
+    The core Sir Bot-a-lot module does **NOTHING** without plugins.
     Check out the list of :ref:`available plugins`.
 
 .. toctree::

docs/installation.rst

@@ -11,14 +11,14 @@ Stable release
 
     Not yet released
 
-To install sir-bot-a-lot, run this command in your terminal:
+To install run this command in your terminal:
 
 .. code-block:: console
 
     $ pip install sir-bot-a-lot
 
-This is the preferred method to install sir-bot-a-lot, as it will always
-install the most recent stable release.
+This is the preferred method as it will always install the most recent stable
+release.
 
 If you don't have `pip`_ installed, this `Python installation guide`_ can guide
 you through the process.

docs/plugins.rst

@@ -58,11 +58,11 @@ Start
 As plugins might need the functionality of other plugins during startup a
 specific order is establish based on each plugin :ref:`conf_starting_priority`.
 
-Sir-bot-a-lot will also wait for a plugin to be fully started before attempting
+Sir Bot-a-lot will also wait for a plugin to be fully started before attempting
 to start the next one. This ensure that no race condition exist in the starting
 process.
 
-When starting a plugin Sir-bot-a-lot create a new asyncio task in order to
+When starting a plugin Sir Bot-a-lot create a new asyncio task in order to
 allow it to run indefinitely.
 
 Example

docs/quickstart.rst

@@ -4,7 +4,7 @@ Quick Start
 
 .. note::
 
-    The core sir-bot-a-lot module does **NOTHING** without plugins.
+    The core Sir Bot-a-lot module does **NOTHING** without plugins.
     Check out the list of :ref:`available plugins`.
 
 Installation
@@ -29,7 +29,8 @@ More installation instruction can be found :ref:`here <installation>`.
 Configuration
 -------------
 
-To load a custom config file use the :code:`--config` argument or the :code:`SIRBOT_CONFIG` environment variable with the configuration file path.
+To load a custom config file use the :code:`--config` argument or the
+:code:`SIRBOT_CONFIG` environment variable with the configuration file path.
 
 The default configuration file look like this: