Skip to content

Commit 251508c

Browse files
committed
finish up the migration guide and put *something* into the acknowledgements
1 parent c4285a0 commit 251508c

File tree

3 files changed

+20
-8
lines changed

3 files changed

+20
-8
lines changed

docs/miscellaneous/acknowledgements.rst

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -3,3 +3,5 @@
33

44
Acknowledgements
55
================
6+
7+
Thanks to all our `contributors <https://github.com/mathsman5133/coc.py/graphs/contributors>`_

docs/miscellaneous/migrating_to_v3.rst

Lines changed: 12 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -17,7 +17,7 @@ Builder Base v2
1717
---------------
1818

1919
The builder base revamp has caused a bunch of breaking changes.
20-
The most significant change is renaming all the `versus` things to `builder_base` things,
20+
The most significant change is renaming all the :attr:`versus` things to :attr:`builder_base` things,
2121
but there were some additions and a removal as well:
2222

2323
- :func:`coc.Client.get_location_clans_versus` -> :func:`coc.Client.get_location_clans_builder_base`
@@ -50,6 +50,16 @@ This is also reflected in the following enumerations:
5050
- :class:`coc.BUILDER_TROOPS_ORDER` now knows the "Electrofire Wizard"
5151
- :class:`coc.HERO_ORDER` now knows the "Battle Copter"
5252

53+
Leagues
54+
-------
55+
56+
Previously the structure of Leagues was a bit messy and not well aligned with what the API provides.
57+
Therefore they got a small rework:
58+
59+
- :class:`WarLeague` was replaced with :class:`BaseLeague` which has the same attributes, but is also used for the builder base league and the clan capital league
60+
- :class:`League` inherits from :class:`BaseLeague` now and adds the :attr:`icon` attribute which is present for home village leagues
61+
- :class:`League` lost its :attr:`localized_name` and :attr:`localized_short_name` attributes as they are not present in the API
62+
5363
Furthermore
5464
-----------
5565

@@ -60,4 +70,4 @@ In order to get more in line with our coding style, the following methods were r
6070

6171
:class:`coc.ClanMember` has a new cached property: :func:`player_house_elements`
6272

63-
:class:`coc.RaidDistrict` has a new `stars` attribute
73+
:class:`coc.RaidDistrict` has a new :attr:`stars` attribute

docs/models/clan_player_attributes.rst

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -21,6 +21,12 @@ Label
2121
:members:
2222
:private-members:
2323

24+
Base League
25+
~~~~~~~~~~~
26+
.. autoclass:: BaseLeague()
27+
:members:
28+
:private-members:
29+
2430
League
2531
~~~~~~
2632
.. autoclass:: League()
@@ -69,9 +75,3 @@ Returns a string that is rendered as the role appears in-game, ie ``Co-Leader``
6975
.. class:: Role
7076

7177
.. py:attribute:: in_game_name
72-
73-
War League
74-
~~~~~~~~~~
75-
.. autoclass:: WarLeague()
76-
:members:
77-
:private-members:

0 commit comments

Comments
 (0)