Browse Source

update docstring on stream.client

pull/34/head
Rossen Georgiev 9 years ago
parent
commit
1465b7f40b
  1. 22
      steam/client/__init__.py

22
steam/client/__init__.py

@ -4,9 +4,6 @@ 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
@ -15,23 +12,16 @@ for details on how to work with events.
| ``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.
.. note::
Mixins can emitter additional events. See their docs pages for details.
Mixins
^^^^^^
.. note::
Additional features are located in separate submodules. All functionality from ``bultins`` is inherited by default.
Optional features are available as :doc:`mixins <api/steam.client.mixins>`.
This allows the client to remain light yet flexible.
.. note::
Optional features are available as ``mixins``. This allows the client to remain light yet flexible.
API
^^^
"""
import os
import logging

Loading…
Cancel
Save