From 1465b7f40bd223d50222f3ecfd2dfce6268185c5 Mon Sep 17 00:00:00 2001 From: Rossen Georgiev Date: Mon, 23 May 2016 10:30:10 +0100 Subject: [PATCH] update docstring on stream.client --- steam/client/__init__.py | 36 +++++++++++++----------------------- 1 file changed, 13 insertions(+), 23 deletions(-) diff --git a/steam/client/__init__.py b/steam/client/__init__.py index 9d0d70b..f605941 100644 --- a/steam/client/__init__.py +++ b/steam/client/__init__.py @@ -4,34 +4,24 @@ Implementation of Steam client based on ``gevent`` Events ^^^^^^ -See `gevent-eventmitter `_ -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 ` - all messages are emitted with their ``EMsg`` -| ``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 ` - all messages are emitted with their ``EMsg`` -Mixing can emitter additional events. See their docs pages for details. +.. note:: + Mixins can emitter additional events. See their docs pages for details. +.. note:: + Additional features are located in separate submodules. All functionality from ``bultins`` is inherited by default. -Builtins -^^^^^^^^ +.. note:: + Optional features are available as ``mixins``. This allows the client to remain light yet flexible. -Additional features are located in separate submodules. -All functionality from :doc:`bultins ` is inherited by default. - -Mixins -^^^^^^ - -Optional features are available as :doc:`mixins `. -This allows the client to remain light yet flexible. - -API -^^^ """ import os import logging