diff options
| author | schneefux <schneefux+commit@schneefux.xyz> | 2017-01-31 12:17:03 +0100 |
|---|---|---|
| committer | schneefux <schneefux+commit@schneefux.xyz> | 2017-01-31 12:17:03 +0100 |
| commit | 214865dbf47818d52190a9d0443d104c1759148a (patch) | |
| tree | 7dbf9299a68708b8573c68df29ea636d3fd1f39e /gamelocker | |
| parent | 4a1d67ecbbf3ba14a986020c0ebf50256de24387 (diff) | |
| download | python-gamelocker-214865dbf47818d52190a9d0443d104c1759148a.tar.gz python-gamelocker-214865dbf47818d52190a9d0443d104c1759148a.zip | |
docs: move init parameters to top level
Diffstat (limited to 'gamelocker')
| -rw-r--r-- | gamelocker/api.py | 17 |
1 files changed, 9 insertions, 8 deletions
diff --git a/gamelocker/api.py b/gamelocker/api.py index ad7e1f6..30fe861 100644 --- a/gamelocker/api.py +++ b/gamelocker/api.py @@ -12,17 +12,18 @@ import gamelocker.strings class Gamelocker(object): - """Implementation of the Gamelocker API.""" + """Implementation of the Gamelocker API. + + :param apikey: API key to authenticate with. + :type apikey: str + :param datacenter: (optional) API endpoint datacenter to use. + :type datacenter: str + :return: :class:`Gamelocker <Gamelocker>` object + :rtype: gamelocker.Gamelocker + """ def __init__(self, apikey, datacenter="dc01"): """Constructs a :class:`Gamelocker <Gamelocker>`. - - :param apikey: API key to authenticate with. - :type apikey: str - :param datacenter: (optional) API endpoint datacenter to use. - :type datacenter: str - :return: :class:`Gamelocker <Gamelocker>` object - :rtype: gamelocker.Gamelocker """ self.apikey = apikey |