Skip to content

Commit 9b6bc4d

Browse files
committed
Repair the support objects documentation.
1 parent d93322f commit 9b6bc4d

File tree

2 files changed

+29
-11
lines changed

2 files changed

+29
-11
lines changed

docs/source/supportobjects.rst

Lines changed: 23 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -6,42 +6,57 @@ Support Structures
66
These dumb data structures help to give meaningful organization and structure to the information in their respective parent resources.
77

88

9+
Entity
10+
------------------
11+
12+
.. autoclass:: Entity
13+
:members:
14+
915
Player
1016
------------------
1117

1218
.. autoclass:: Player
1319
:members:
1420

21+
User
22+
------------------
23+
24+
.. autoclass:: User
25+
:members:
1526

1627
Observer
17-
---------------
28+
------------------
1829

1930
.. autoclass:: Observer
2031
:members:
2132

33+
Computer
34+
------------------
2235

23-
Person
24-
-------------
36+
.. autoclass:: Computer
37+
:members:
2538

26-
.. autoclass:: Person
27-
:members:
39+
Participant
40+
------------------
2841

42+
.. autoclass:: Participant
43+
:members:
2944

3045
Team
31-
----------------
46+
------------------
3247

3348
.. autoclass:: Team
3449
:members:
3550

3651

3752
PlayerSummary
38-
-----------------
53+
------------------
3954

4055
.. autoclass:: PlayerSummary
4156
:members:
4257

4358
Graph
44-
-----------
59+
------------------
4560

4661
.. autoclass:: Graph
4762
:members:

sc2reader/objects.py

Lines changed: 6 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -243,7 +243,8 @@ def url(self):
243243

244244

245245
class Observer(Entity, User):
246-
"""
246+
""" Extends :class:`Entity` and :class:`User`.
247+
247248
:param integer sid: The entity's unique slot id.
248249
:param dict slot_data: The slot data associated with this entity
249250
:param integer uid: The user's unique user id
@@ -262,7 +263,8 @@ def __str__(self):
262263

263264

264265
class Computer(Entity, Player):
265-
"""
266+
""" Extends :class:`Entity` and :class:`Player`
267+
266268
:param integer sid: The entity's unique slot id.
267269
:param dict slot_data: The slot data associated with this entity
268270
:param integer pid: The player's unique player id.
@@ -281,7 +283,8 @@ def __str__(self):
281283

282284

283285
class Participant(Entity, User, Player):
284-
"""
286+
""" Extends :class:`Entity`, :class:`User`, and :class:`Player`
287+
285288
:param integer sid: The entity's unique slot id.
286289
:param dict slot_data: The slot data associated with this entity
287290
:param integer uid: The user's unique user id

0 commit comments

Comments
 (0)