Browse Source

fix some docstrings

pull/202/head
Rossen Georgiev 6 years ago
parent
commit
c5e31508de
  1. 17
      steam/client/__init__.py
  2. 2
      steam/client/builtins/leaderboards.py

17
steam/client/__init__.py

@ -253,11 +253,12 @@ class SteamClient(CMClient, BuiltinBase):
def wait_msg(self, event, timeout=None, raises=None): def wait_msg(self, event, timeout=None, raises=None):
"""Wait for a message, similiar to :meth:`.wait_event` """Wait for a message, similiar to :meth:`.wait_event`
:param event: :class:`.EMsg' or job id :param event: :class:`.EMsg` or job id
:type event: :class:`.EMsg` or :class:`str`
:param timeout: seconds to wait before timeout :param timeout: seconds to wait before timeout
:type timeout: :class:`int` :type timeout: :class:`int`
:param raises: On timeout when ``False` returns :class:`None`, else raise :class:`gevent.Timeout` :param raises: On timeout when ``False`` returns :class:`None`, else raise :class:`gevent.Timeout`
:type raises: :class:`bool` :type raises: :class:`bool`
:return: returns a message or :class:`None` :return: returns a message or :class:`None`
:rtype: :class:`None`, or `proto message` :rtype: :class:`None`, or `proto message`
:raises: ``gevent.Timeout`` :raises: ``gevent.Timeout``
@ -268,7 +269,7 @@ class SteamClient(CMClient, BuiltinBase):
return resp[0] return resp[0]
def send(self, message, body_params=None): def send(self, message, body_params=None):
""".. versionchanged:: 0.8.4 """
Send a message to CM Send a message to CM
:param message: a message instance :param message: a message instance
@ -285,7 +286,7 @@ class SteamClient(CMClient, BuiltinBase):
CMClient.send(self, message) CMClient.send(self, message)
def send_job(self, message, body_params=None): def send_job(self, message, body_params=None):
""".. versionchanged:: 0.8.4 """
Send a message as a job Send a message as a job
.. note:: .. note::
@ -322,7 +323,7 @@ class SteamClient(CMClient, BuiltinBase):
return "job_%d" % jobid return "job_%d" % jobid
def send_job_and_wait(self, message, body_params=None, timeout=None, raises=False): def send_job_and_wait(self, message, body_params=None, timeout=None, raises=False):
""".. versionchanged:: 0.8.4 """
Send a message as a job and wait for the response. Send a message as a job and wait for the response.
.. note:: .. note::
@ -347,7 +348,7 @@ class SteamClient(CMClient, BuiltinBase):
return response[0].body return response[0].body
def send_message_and_wait(self, message, response_emsg, body_params=None, timeout=None, raises=False): def send_message_and_wait(self, message, response_emsg, body_params=None, timeout=None, raises=False):
""".. versionchanged:: 0.8.4 """
Send a message to CM and wait for a defined answer. Send a message to CM and wait for a defined answer.
:param message: a message instance :param message: a message instance

2
steam/client/builtins/leaderboards.py

@ -108,7 +108,7 @@ class SteamLeaderboard(object):
:type end: :class:`int` :type end: :class:`int`
:param data_request: data being requested :param data_request: data being requested
:type data_request: :class:`steam.enums.common.ELeaderboardDataRequest` :type data_request: :class:`steam.enums.common.ELeaderboardDataRequest`
:param steam_ids: list of steam ids when using :prop:`.ELeaderboardDataRequest.Users` :param steam_ids: list of steam ids when using :attr:`.ELeaderboardDataRequest.Users`
:type steamids: :class:`list` :type steamids: :class:`list`
:return: a list of entries, see ``CMsgClientLBSGetLBEntriesResponse`` :return: a list of entries, see ``CMsgClientLBSGetLBEntriesResponse``
:rtype: :class:`list` :rtype: :class:`list`

Loading…
Cancel
Save