Skip to content

Commit

Permalink
some more doc updates to make shorter codeblocks
Browse files Browse the repository at this point in the history
  • Loading branch information
SharpBit committed Oct 6, 2024
1 parent e89c487 commit 59f4bf6
Showing 1 changed file with 7 additions and 3 deletions.
10 changes: 7 additions & 3 deletions docs/api.rst
Original file line number Diff line number Diff line change
Expand Up @@ -94,12 +94,14 @@ Member

Members is a list of club members. Get this by accessing
``Club.members`` or ``Club.get_members()``.
The club's members are sorted in order of descending trophies.
Each Member in the list has the following attributes:

.. code:: py
members = club.members
print(members[0].name, members[0].role) # prints best player's name and role (sorted by trophies)
# Prints club's best player's name and role
print(members[0].name, members[0].role)
Attributes:

Expand Down Expand Up @@ -158,8 +160,10 @@ can only be accessed from ``Player.brawlers``.
.. code:: py
brawlers = player.brawlers
top_brawler = brawlers[0] # first index in list = highest trophies
print(top_brawler.name, top_brawler.trophies) # prints best brawler's name and trophies
# List is sorted by descending trophies
top_brawler = brawlers[0]
# print the player's best brawler's name and trophies
print(top_brawler.name, top_brawler.trophies)
Attributes:

Expand Down

0 comments on commit 59f4bf6

Please sign in to comment.