Skip to content

Commit 450b3cc

Browse files
committed
update documentation
1 parent b326e45 commit 450b3cc

2 files changed

Lines changed: 29 additions & 39 deletions

File tree

brawlstats/models.py

Lines changed: 0 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -95,9 +95,6 @@ def __len__(self):
9595
def __repr__(self):
9696
return '<Members object count={}>'.format(len(self))
9797

98-
def __str__(self):
99-
return 'Members containing {} items'.format(len(self))
100-
10198

10299
class Ranking(BaseBox):
103100
"""
@@ -113,9 +110,6 @@ def __len__(self):
113110
def __repr__(self):
114111
return '<Ranking object count={}>'.format(len(self))
115112

116-
def __str__(self):
117-
return 'Ranking containing {} items'.format(len(self))
118-
119113

120114
class BattleLog(BaseBox):
121115
"""

docs/api.rst

Lines changed: 29 additions & 33 deletions
Original file line numberDiff line numberDiff line change
@@ -26,6 +26,11 @@ Data Models
2626
:members:
2727

2828

29+
Attributes of Data Models
30+
~~~~~~~~~~~~~~~~~~~~~~~~~
31+
32+
Note: These are subject to change at any time. Visit https://developer.brawlstars.com/#/documentation to view up-to-date information on the API.
33+
2934
Player
3035
~~~~~~
3136

@@ -34,24 +39,28 @@ A full player object (all its statistics)
3439

3540
Attributes:
3641

37-
============================ =============
38-
Name Type
39-
============================ =============
40-
``name`` str
41-
``name_color`` str
42-
``trophies`` int
43-
``highest_trophies`` int
44-
``exp_level`` int
45-
``exp_points`` int
46-
``x3_vs_3_victories`` int
47-
``solo_victories`` int
48-
``duo_victories`` int
49-
``best_robo_rumble_time`` int
50-
``best_time_as_big_brawler`` int
51-
``club.tag`` str
52-
``club.name`` str
53-
``brawlers`` List[Brawler]
54-
============================ =============
42+
============================================ =============
43+
Name Type
44+
============================================ =============
45+
``tag`` str
46+
``name`` str
47+
``name_color`` str
48+
``trophies`` int
49+
``highest_trophies`` int
50+
``power_play_points`` int
51+
``highest_power_play_points`` int
52+
``exp_level`` int
53+
``exp_points`` int
54+
``is_qualified_from_championship_challenge`` bool
55+
``x3_vs_3_victories`` int
56+
``solo_victories`` int
57+
``duo_victories`` int
58+
``best_robo_rumble_time`` int
59+
``best_time_as_big_brawler`` int
60+
``club.tag`` str
61+
``club.name`` str
62+
``brawlers`` List[Brawler]
63+
============================================ =============
5564

5665
Club
5766
~~~~
@@ -102,7 +111,7 @@ Ranking
102111

103112
Returns a list of top players, clubs, or brawlers. To access this, do ``ranking[index]``
104113

105-
Player attributes:
114+
Player/Brawler attributes:
106115

107116
============== ====
108117
Name Type
@@ -127,24 +136,11 @@ Name Type
127136
``member_count`` int
128137
================ ====
129138

130-
Brawler attributes:
131-
132-
============== ====
133-
Name Type
134-
============== ====
135-
``tag`` str
136-
``name`` str
137-
``name_color`` str
138-
``trophies`` int
139-
``rank`` int
140-
``club.name`` str
141-
============== ====
142-
143139
Brawler
144140
~~~~~~~
145141

146142
Returns a brawler object with the following attributes. You can retrieve
147-
a profile’s brawler info by getting Profile.brawlers
143+
a profile’s brawler info by getting ``Profile.brawlers``
148144

149145
.. code:: py
150146

0 commit comments

Comments
 (0)