Various documentation fixes.

Author: patternspandemic

docs/api/bot.rst

@@ -41,7 +41,7 @@ components.
 
       The username of the bot's owner, which will be displayed in the ``/help``
       command. This attribute will be sent directly to the user, so if you want
-      to insert an username be sure to prefix it with ``@``, so the Telegram
+      to insert a username be sure to prefix it with ``@``, so the Telegram
       client will make that text clickable.
 
    .. py:attribute:: before_help
@@ -84,8 +84,7 @@ components.
       parameters:
 
       * A ``chat`` parameter with the representation of the chat in which the
-        message was sent (either an instance of :py:class:`botogram.User` or
-        :py:class:`botogram.GroupChat`)
+        message was sent (an instance of :py:class:`botogram.Chat`)
       * A ``message`` parameter with the representation of the received
         message (an instance of :py:class:`botogram.Message`)
 
@@ -99,8 +98,7 @@ components.
       will be called with two parameters:
 
       * A ``chat`` parameter with the representation of the chat in which the
-        message was sent (either an instance of :py:class:`botogram.User` or
-        :py:class:`botogram.GroupChat`)
+        message was sent (an instance of :py:class:`botogram.Chat`)
       * A ``message`` parameter with the representation of the received
         message (an instance of :py:class:`botogram.Message`)
 
@@ -122,9 +120,8 @@ components.
       called with two parameters:
 
       * A ``chat`` parameter with the representation of the chat in which the
-        message was sent (either an instance of :py:class:`botogram.User` or
-        :py:class:`botogram.GroupChat`)
-      * A ``message`` parameter witht the representation of the received
+        message was sent (an instance of :py:class:`botogram.Chat`)
+      * A ``message`` parameter with the representation of the received
         message (an instance of :py:class:`botogram.Message`).
 
       If the function returns ``True``, then the message processing is stopped,
@@ -142,8 +139,7 @@ components.
       message. Decorated functions will be called with two parameters:
 
       * A ``chat`` parameter with the representation of the chat in which the
-        message was sent (either an instance of :py:class:`botogram.User` or
-        :py:class:`botogram.GroupChat`)
+        message was sent (an instance of :py:class:`botogram.Chat`)
       * A ``message`` parameter with the representation of the received
         message (an instance of :py:class:`botogram.Message`)
 
@@ -164,8 +160,7 @@ components.
       be called with two parameters:
 
       * A ``chat`` parameter with the representation of the chat in which the
-        message was sent (either an instance of :py:class:`botogram.User` or
-        :py:class:`botogram.GroupChat`)
+        message was sent (an instance of :py:class:`botogram.Chat`)
       * A ``message`` parameter with the representation of the received
         message (an instance of :py:class:`botogram.Message`)
       * A ``matches`` parameter with a tuple containing the matched groups
@@ -186,8 +181,7 @@ components.
       three parameters:
 
       * A ``chat`` parameter with the representation of the chat in which the
-        message was sent (either an instance of :py:class:`botogram.User` or
-        :py:class:`botogram.GroupChat`)
+        message was sent (an instance of :py:class:`botogram.Chat`)
       * A ``message`` parameter with the representation of the received
         message (an instance of :py:class:`botogram.Message`)
       * An ``args`` parameter with the list of parsed arguments

docs/api/channels.rst

@@ -15,7 +15,7 @@ just want to send messages to a channel, it's better if you use this.
 
    Create a new :py:class:`~botogram.Chat` object which points to the channel.
    You need to provide the channel name, prefixed with ``@``, and your bot's
-   API key. Please refer to the :ref:`channels-preparation <preparations>`
+   API key. Please refer to the :ref:`channels-preparation`
    section if you don't know how to get it.
 
    :param str name: The channel name.

docs/api/components.rst

@@ -28,7 +28,7 @@ about how to create them in the ":ref:`custom-components`" chapter.
    .. py:attribute:: component_name
 
       The name of the component. If you subclass the class in order to create a
-      custom component, be sure to set it to an appropiate value.
+      custom component, be sure to set it to an appropriate value.
 
    .. py:method:: add_before_processing_hook(func)
 
@@ -38,8 +38,7 @@ about how to create them in the ":ref:`custom-components`" chapter.
       Provided functions will be called with two parameters:
 
       * A ``chat`` parameter with the representation of the chat in which the
-        message was sent (either an instance of :py:class:`botogram.User` or
-        :py:class:`botogram.GroupChat`)
+        message was sent (an instance of :py:class:`botogram.Chat`)
       * A ``message`` parameter with the representation of the received
         message (an instance of :py:class:`botogram.Message`)
 
@@ -55,8 +54,7 @@ about how to create them in the ":ref:`custom-components`" chapter.
       will be called with two parameters:
 
       * A ``chat`` parameter with the representation of the chat in which the
-        message was sent (either an instance of :py:class:`botogram.User` or
-        :py:class:`botogram.GroupChat`)
+        message was sent (an instance of :py:class:`botogram.Chat`)
       * A ``message`` parameter with the representation of the received
         message (an instance of :py:class:`botogram.Message`)
 
@@ -73,9 +71,8 @@ about how to create them in the ":ref:`custom-components`" chapter.
       parameters:
 
       * A ``chat`` parameter with the representation of the chat in which the
-        message was sent (either an instance of :py:class:`botogram.User` or
-        :py:class:`botogram.GroupChat`)
-      * A ``message`` parameter witht the representation of the received
+        message was sent (an instance of :py:class:`botogram.Chat`)
+      * A ``message`` parameter with the representation of the received
         message (an instance of :py:class:`botogram.Message`).
 
       If the function returns ``True``, then the message processing is stopped,
@@ -94,8 +91,7 @@ about how to create them in the ":ref:`custom-components`" chapter.
       message. Provided functions will be called with two parameters:
 
       * A ``chat`` parameter with the representation of the chat in which the
-        message was sent (either an instance of :py:class:`botogram.User` or
-        :py:class:`botogram.GroupChat`)
+        message was sent (an instance of :py:class:`botogram.Chat`)
       * A ``message`` parameter with the representation of the received
         message (an instance of :py:class:`botogram.Message`)
 
@@ -117,8 +113,7 @@ about how to create them in the ":ref:`custom-components`" chapter.
       be called with three parameters:
 
       * A ``chat`` parameter with the representation of the chat in which the
-        message was sent (either an instance of :py:class:`botogram.User` or
-        :py:class:`botogram.GroupChat`)
+        message was sent (an instance of :py:class:`botogram.Chat`)
       * A ``message`` parameter with the representation of the received
         message (an instance of :py:class:`botogram.Message`)
       * A ``matches`` parameter with a tuple containing the matched groups
@@ -140,8 +135,7 @@ about how to create them in the ":ref:`custom-components`" chapter.
       three parameters:
 
       * A ``chat`` parameter with the representation of the chat in which the
-        message was sent (either an instance of :py:class:`botogram.User` or
-        :py:class:`botogram.GroupChat`)
+        message was sent (an instance of :py:class:`botogram.Chat`)
       * A ``message`` parameter with the representation of the received
         message (an instance of :py:class:`botogram.Message`)
       * An ``args`` parameter with the list of parsed arguments

docs/api/index.rst

@@ -7,7 +7,7 @@
 API reference
 ~~~~~~~~~~~~~
 
-This section will cover the full reference of the botogram's public API. The
+This section will cover the full reference of botogram's public API. The
 API will be kept backward compatible for at least the next release, even if
 the development will be made trying to not break anything.
 

docs/api/utility.rst

@@ -48,15 +48,15 @@ development. Feel free to use them when you need them.
 
    This decorator does nothing currently. If you still use it, just remove all
    the references to it in your source code. Your bot will still work
-   flawlessy.
+   flawlessly.
 
    .. deprecated:: ae3314ed it will be removed in botogram 1.0
 
 .. py:decorator:: botogram.pass_bot
 
    This decorator does nothing currently. If you still use it, just remove all
    the references to it in your source code. Your bot will still work
-   flawlessy.
+   flawlessly.
 
    .. deprecated:: ae3314ed it will be removed in botogram 1.0
 

docs/channels.rst

@@ -31,7 +31,7 @@ The final step is to add your bot as an administrator of the channel. Open your
 favourite Telegram client, and go to the administrators' section of your
 channel. From it you should add your bot, and then you're ready.
 
-.. _chanels-standalone:
+.. _channels-standalone:
 
 =========================
 Manage without a full bot
@@ -50,8 +50,8 @@ channel object:
 
 You need to replace ``@my_channel`` with your channel's public name, and
 ``YOUR_API_KEY`` with the key you got before. Then you can use all the methods
-of the :py:class:`~botogram.Chat` object with the instance you got. For
-example, if you want to send a text message you should do:
+of the :py:class:`~botogram.Chat` object with the instance you are returned.
+For example, if you want to send a text message you should do:
 
 .. code-block:: python
    :emphasize-lines: 2
@@ -88,3 +88,4 @@ cites botogram in a chat, you can do this:
            user = message.from_.username
 
        bot.send("@my_channel", "%s mentioned botogram!" % user)
+.. _@botfather: https://telegram.me/botfather

docs/custom-components.rst

@@ -8,11 +8,11 @@ Creating custom components
 ~~~~~~~~~~~~~~~~~~~~~~~~~~
 
 Hopefully you'll get to a point when you've made a few bots. The problem is,
-there's an high chance parts of the code are duplicate in the bots. For
+there's a high chance parts of the code are duplicated between the bots. For
 example, if your bots are meant to be used only by some people, you'll have
 duplicate code which filters who can interact with the bot.
 
-Components provides an easy and elegant way to solve the problem: instead of
+Components provide an easy and elegant way to solve the problem: instead of
 copy-pasting the shared code in each bot, they allow you to create isolated
 groups of hooks, commands and so on, then you can import and use them in each
 bot.
@@ -24,13 +24,15 @@ Components code of conduct
 ==========================
 
 If you want to distribute your components, you should follow these simple rules
-while coding it. This way all components will adhere to the same standars,
+while coding them. This way all components will adhere to the same standards,
 simplifying the end-user experience:
 
-* **Give appropiate names to your components**. Component names are used to
-  give the end-user a hint about when that thing was defined. Also, make sure
-  your name isn't used by someone else, for example adding your nickname as a
-  prefix.
+* **Give appropriate names to your components**. Naming your component
+  appropriately will help users identify runtime actions involving your
+  component, such as when the component is loaded into their bot, or if a hook
+  defined by your component is called (when running in debug mode). Also, to
+  be sure your component's name isn't used by someone else, consider adding
+  your nickname as a prefix.
 
 * **Don't assume your component will be used only by one bot**. Try to design
   your component in a way it can be used by multiple bots at once. This
@@ -129,7 +131,7 @@ Using a custom component
 If you want to use a component you created in your bots, you need to initialize
 its object and apply it to each bot you want. We're going to apply the
 ``myacl`` component we wrote before, which should be in a separated file, to
-the hello world you can find in the index of the docs:
+the hello world bot you can find in the index of the docs:
 
 .. code-block:: python
 

docs/deploy/common.rst

@@ -5,7 +5,7 @@
 Common deployment information
 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
 
-Even if different deployments techniques are *really* different, all of them
+Even if different deployment techniques are *really* different, all of them
 have two essential things in common: server security and application
 configuration.
 
@@ -14,7 +14,7 @@ Server security considerations
 
 In a perfect world, you wouldn't need to worry about securing your servers,
 because no one would attempt to break them. Unfortunately, we don't live in
-that world, so you need to protect your server from the ones who loves breaking
+that world, so you need to protect your server from the ones who love breaking
 others' things.
 
 * **You need to have experience in servers management**. Servers aren't easy to
@@ -28,7 +28,7 @@ others' things.
   attacker won't be able to do too much damage on your system.
 
 * **Keeping services separated is a good idea**. In order to restrict even more
-  what an hypothetical attacker can do, you can created a separated user for
+  what an hypothetical attacker can do, you can create a separate user for
   *each* service you have on your server. This way an attacker can't even
   compromise other applications.
 
@@ -46,15 +46,15 @@ traffic (for example bots only for a single group chat) this might become
 annoying.
 
 The solution is to run multiple bots in a single runner, since adding bots to a
-runner is way more inexpensive instead of creating a runner per bot. Be warned
-that if you add too much bots in a single runner, the workers might not be able
+runner is way more inexpensive than creating a runner per bot. Be warned
+that if you add too many bots to a single runner, the workers might not be able
 to keep up with the incoming requests.
 
-In order to make this happening, you need to have each bot in an importable
+In order to make this happen, you need to have each bot in an importable
 Python file, and then create a file which calls :py:func:`botogram.run` with
 the bots' instances. For example, if you have two bots in ``mybot1.py`` and
 ``mybot2.py``, and the bot instance in all of them is called ``bot``, you can
-use this script to run all of them:
+use this script to run both of them in a single runner:
 
 .. code-block:: python
 

docs/deploy/supervisord.rst

@@ -7,7 +7,7 @@ Deploy with Supervisor
 
 Supervisor_ is a process management system written in Python, which allows you
 to run applications in a controlled and reliable way. It features running
-things in the background, rotation of the log files, and automatically restarts
+things in the background, rotation of the log files, and automatic restarts
 of crashed applications.
 
 Supervisor is the best choice for deploying botogram-powered bots, since it
@@ -53,7 +53,7 @@ init system.
 Preparation of the bot
 ======================
 
-First thing to do is to create an user which will own the bot. This allows your
+First thing to do is to create a user which will own the bot. This allows your
 bot to run in isolation from other processes, increasing the security of your
 deployment. The user will be called ``telegrambot`` (from **root**)::
 

docs/index.rst

@@ -1,5 +1,5 @@
 .. Copyright (c) 2015 Pietro Albini <[email protected]>
-   Released under the MIT licende
+   Released under the MIT license
 
 ~~~~~~~~~~~~~~~~~~~~~~
 botogram documentation