Browse Source

docs: clean up docstrings

pull/41/head
Rossen Georgiev 9 years ago
parent
commit
ce47476f4c
  1. 4
      steam/webapi.py
  2. 4
      steam/webauth.py

4
steam/webapi.py

@ -100,7 +100,7 @@ class WebAPI(object):
self.http_timeout = http_timeout #: HTTP timeout in seconds self.http_timeout = http_timeout #: HTTP timeout in seconds
self.apihost = apihost #: ..versionadded:: 0.8.3 apihost hostname self.apihost = apihost #: ..versionadded:: 0.8.3 apihost hostname
self.interfaces = [] #: list of all interfaces self.interfaces = [] #: list of all interfaces
self.session = _make_session() #: :class:`requests.Session` from :func:`steam.util.web.make_requests_session` self.session = _make_session() #: :class:`requests.Session` from :func:`.make_requests_session`
if auto_load_interfaces: if auto_load_interfaces:
self.load_interfaces(self.fetch_interfaces()) self.load_interfaces(self.fetch_interfaces())
@ -118,7 +118,7 @@ class WebAPI(object):
:return: :class:`dict` of all interfaces and methods :return: :class:`dict` of all interfaces and methods
The returned value can passed to :py:func:`WebAPI.load_interfaces` The returned value can passed to :meth:`load_interfaces`
""" """
return get('ISteamWebAPIUtil', 'GetSupportedAPIList', 1, return get('ISteamWebAPIUtil', 'GetSupportedAPIList', 1,
https=self.https, https=self.https,

4
steam/webauth.py

@ -10,7 +10,7 @@ The session can be used to access ``steamcommunity.com``, ``store.steampowered.c
Keep in mind if you are trying to write robust code. Keep in mind if you are trying to write robust code.
.. note:: .. note::
If you are using :class:`steam.client.SteamClient`, use :meth:`steam.client.builtins.web.Web.get_web_session()` If you are using :class:`.SteamClient` take a look at :meth:`.get_web_session()`
.. note:: .. note::
If you need to authenticate as a mobile device for things like trading confirmations If you need to authenticate as a mobile device for things like trading confirmations
@ -78,7 +78,7 @@ class WebAuth(object):
complete = False #: whether authentication has been completed successfully complete = False #: whether authentication has been completed successfully
session = None #: :class:`requests.Session` (with auth cookies after auth is complete) session = None #: :class:`requests.Session` (with auth cookies after auth is complete)
captcha_gid = -1 captcha_gid = -1
steam_id = None #: :class:`steam.steamid.SteamID` (after auth is complete) steam_id = None #: :class:`.SteamID` (after auth is complete)
def __init__(self, username, password): def __init__(self, username, password):
self.__dict__.update(locals()) self.__dict__.update(locals())

Loading…
Cancel
Save