docs: add event details for SteamClient; fix typos

docs/api/steam.client.rst

@@ -1,11 +1,13 @@
 steam.client
 ============
 
+.. automodule:: steam.client
+    :members: SteamClient
+    :undoc-members:
+    :show-inheritance:
+
 .. toctree::
     steam.client.builtins
     steam.client.mixins
     steam.client.gc
 
-.. automodule:: steam.client
-    :members:
-    :show-inheritance:

docs/index.rst

@@ -18,10 +18,10 @@ Supports Python ``2.7+`` and ``3.4+``.
 
 Main features:
 
-* :class:`SteamID <steam.steamid.SteamID>` - convert between the various ID representations with ease
+* :doc:`SteamID <api/steam.steamid>` - convert between the various ID representations with ease
-* :class:`WebAPI <steam.webapi.WebAPI>` - simple API for Steam's Web API with automatic population of interfaces
+* :doc:`WebAPI <api/steam.webapi>` - simple API for Steam's Web API with automatic population of interfaces
-* :class:`WebAuth <steam.webauth.WebAuth>` - authentication for access to ``store.steampowered.com`` and ``steamcommunity.com``
+* :doc:`WebAuth <api/steam.webauth>` - authentication for access to ``store.steampowered.com`` and ``steamcommunity.com``
-* :class:`SteamClient <steam.client.SteamClient>` - communication with the steam network based on ``gevent``.
+* :doc:`SteamClient <api/steam.client>` - communication with the steam network based on ``gevent``.
 
 Checkout the :doc:`user_guide` for examples, or the :doc:`api/index` for details.
 

steam/client/__init__.py

@@ -1,3 +1,38 @@
+"""
+Implementation of Steam client based on ``gevent``
+
+Events
+^^^^^^
+
+See `gevent-eventmitter <https://github.com/rossengeorgiev/gevent-eventemitter>`_
+for details on how to work with events.
+
+| ``connected`` - when successful connection with a CM server is established
+| ``disconnected`` - when connection is lost
+| ``channel_secured`` - after channel encryption is complete, client can attempt to login now
+| ``error`` - after login failure
+| ``auth_code_required`` - either email code or 2FA code is needed for login
+| ``logged_on`` - after successful login, client can send messages
+| :class:`EMsg <steam.enums.emsg.EMsg>` - all messages are emitted with their ``EMsg``
+
+Mixing can emitter additional events. See their docs pages for details.
+
+
+Builtins
+^^^^^^^^
+
+Additional features are located in separate submodules.
+All functionality from :doc:`bultins <api/steam.client.builtins>` is inherited by default.
+
+Mixins
+^^^^^^
+
+Optional features are available as :doc:`mixins <api/steam.client.mixins>`.
+This allows the client to remain light yet flexible.
+
+API
+^^^
+"""
 import os
 import logging
 import gevent
@@ -16,12 +51,6 @@ from steam.client.builtins import BuiltinBase
 
 
 class SteamClient(CMClient, BuiltinBase):
-    """
-    Implementation of Steam client based on ``gevent``
-
-    See `gevent-eventmitter <https://github.com/rossengeorgiev/gevent-eventemitter>`_
-    for details on how to work with events.
-    """
     _reconnect_backoff_c = 0
     current_jobid = 0
     credential_location = None  #: location for sentry

steam/client/builtins/__init__.py

@@ -1,5 +1,5 @@
 """
-All high level features of :class:`steam.client.SteamClient` are implemented here in seperate submodules.
+All high level features of :class:`steam.client.SteamClient` are implemented here in separate submodules.
 """
 from steam.client.builtins.misc import Misc
 from steam.client.builtins.user import User
@@ -8,6 +8,6 @@ from steam.client.builtins.web import Web
 class BuiltinBase(Misc, User, Web):
     """
     This object is used as base to implement all high level functionality.
-    The features are seperated into submodules.
+    The features are separated into submodules.
     """
     pass

steam/client/gc.py

@@ -36,7 +36,7 @@ Example usage for sending client hello to Dota 2's GC.
     gc.send(header, body.SerializeToString())
 
 The above code assumes that we have a ``myDotaModule`` that contains the appropriate
-data structures, which can be used to (de)serialize messages. For example, protobufs.
+data structures, which can be used to (de)serialize messages such as protobufs.
 """
 import logging
 import gevent

steam/client/mixins/__init__.py

@@ -1,7 +1,7 @@
 """
 All optional features are available as mixins for :class:`steam.client.SteamClient`.
 Using this approach the client can remain light yet flexible.
-Functionallity can be added though inheritance depending on the use case.
+Functionality can be added though inheritance depending on the use case.
 
 
 Here is quick example of how to use one of the available mixins.
@@ -25,7 +25,7 @@ Making custom mixing is just as simple.
     Take care not to override existing methods or properties, otherwise bad things will happen
 
 .. note::
-    To avoid name collisions of non-public variables and methods, see `Private Variables <https://docs.python.org/2/tutorial/classes.html#private-variables-and-class-local-references>`_
+    To avoid name collisions of non-public variables and methods, use `Private Variables <https://docs.python.org/2/tutorial/classes.html#private-variables-and-class-local-references>`_
 
 .. code:: python
 

steam/webapi.py

@@ -1,5 +1,5 @@
 """
-WebAPI provides a thin gevent cooperative wrapper over Steam's WebAPI
+WebAPI provides a thin wrapper over `Steam's Web API <https://developer.valvesoftware.com/wiki/Steam_Web_API>`_
 
 Calling an endpoint