Skip to content

Commit 9d32660

Browse files
textwrap LICENSE; tweaks to README
1 parent c8df3ad commit 9d32660

File tree

2 files changed

+24
-6
lines changed

2 files changed

+24
-6
lines changed

LICENSE

+15-3
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,19 @@
11
Copyright (c) 2015 Rossen Georgiev <[email protected]>
22

3-
Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:
3+
Permission is hereby granted, free of charge, to any person obtaining a copy of
4+
this software and associated documentation files (the "Software"), to deal in
5+
the Software without restriction, including without limitation the rights to
6+
use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies
7+
of the Software, and to permit persons to whom the Software is furnished to do
8+
so, subject to the following conditions:
49

5-
The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.
10+
The above copyright notice and this permission notice shall be included in all
11+
copies or substantial portions of the Software.
612

7-
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
13+
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
14+
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
15+
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
16+
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
17+
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
18+
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
19+
SOFTWARE.

README.rst

+9-3
Original file line numberDiff line numberDiff line change
@@ -21,14 +21,18 @@ What interfaces are availability depends on the ``key``.
2121
{u'response': {u'steamid': u'103582791429521412', u'success': 1}}
2222
2323
It's not necessary to provide the key when calling any interface method.
24-
However, you can incase you want to fire one off call with a different ``key``.
24+
``key``, ``format``, ``raw`` parameters can be specified on ``WebAPI`` to affect
25+
all method calls, or when calling a specific method.
2526
Some methods have parameters which need to be a ``list``.
2627

27-
Supported formats by web api are: ``json (default)``, ``vdf``, ``xml``
28+
Supported formats by web api are: ``json`` (default), ``vdf``, ``xml``
29+
The response will be deserialized using the appropriet module unless ``raw`` is
30+
``True``.
2831

2932
.. code:: python
3033
3134
>>> print api.ISteamUser.ResolveVanityURL.doc() # method doc
35+
"""
3236
ResolveVanityURL (version: 1)
3337
3438
Parameters:
@@ -39,10 +43,12 @@ Supported formats by web api are: ``json (default)``, ``vdf``, ``xml``
3943
vanityurl string required
4044
- The vanity URL to get a SteamID for
4145
46+
"""
4247
>>> print api.ISteamUser.doc() # interface and all methods
4348
>>> print api.doc() # all available interfaces
4449
45-
Checkout the wiki has a `list of the currently available API interfaces`_.
50+
51+
Checkout the wiki for a `list of the currently available API interfaces`_.
4652

4753

4854
SteamID

0 commit comments

Comments
 (0)