Skip to content

Commit ff94b65

Browse files
majordoobiemajordoobie
authored
Revert "fix the docs"
1 parent 2dba5cf commit ff94b65

File tree

18 files changed

+71
-143
lines changed

18 files changed

+71
-143
lines changed

‎coc/__init__.py‎

Lines changed: 0 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -75,10 +75,7 @@
7575
TimeDelta,
7676
Label,
7777
WarLeague,
78-
GoldPassSeason,
79-
ChatLanguage
8078
)
81-
from .entry_logs import LogPaginator, ClanWarLog, RaidLog
8279
from .players import Player, ClanMember, RankedPlayer
8380
from .player_clan import PlayerClan
8481
from .spell import Spell
@@ -88,4 +85,3 @@
8885
from .war_members import ClanWarLeagueClanMember, ClanWarMember
8986
from .wars import ClanWar, ClanWarLogEntry, ClanWarLeagueGroup
9087
from . import utils
91-
from .raid import RaidLogEntry, RaidClan, RaidMember, RaidAttack, RaidDistrict

‎coc/hero.py‎

Lines changed: 0 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -52,9 +52,6 @@ class Hero(DataContainer):
5252
village: str
5353
Either ``home`` or ``builderBase``, indicating which village this hero belongs to.
5454
"""
55-
__slots__ = ("id", "name", "range", "dps", "hitpoints", "ground_target", "speed", "upgrade_cost",
56-
"upgrade_time", "ability_time", "required_th_level", "regeneration_time", "level",
57-
"max_level", "village")
5855
name: str
5956
level: int
6057
max_level: int
@@ -143,8 +140,6 @@ class Pet(DataContainer):
143140
village: str
144141
Either ``home`` or ``builderBase``, indicating which village this pet belongs to.
145142
"""
146-
__slots__ = ("id", "name", "range", "dps", "ground_target", "hitpoints", "speed", "upgrade_cost",
147-
"upgrade_resource", "upgrade_time", "level", "max_level", "village")
148143
name: str
149144
level: int
150145
max_level: int

‎coc/raid.py‎

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -28,6 +28,10 @@
2828
from .miscmodels import Badge, Timestamp, try_enum
2929
from .utils import cached_property, correct_tag
3030

31+
if TYPE_CHECKING:
32+
# pylint: disable=cyclic-import
33+
from .war_members import ClanWarMember # noqa
34+
3135

3236
class RaidMember(BasePlayer):
3337
"""Represents a Raid Member that the API returns.

‎coc/spell.py‎

Lines changed: 0 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -47,9 +47,6 @@ class Spell(DataContainer):
4747
village: str
4848
Either ``home`` or ``builderBase``, indicating which village this spell belongs to.
4949
"""
50-
__slots__ = ("id", "name", "range", "upgrade_cost", "upgrade_resource", "upgrade_time",
51-
"training_cost", "training_resource", "training_time", "is_siege_machine", "level", "max_level",
52-
"village")
5350
name: str
5451
level: int
5552
max_level: int

‎coc/troop.py‎

Lines changed: 4 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -37,13 +37,13 @@ class Troop(DataContainer):
3737
+----------------------------------+-------------------+
3838
| :attr:`Troop.upgrade_resource` | :class:`Resource` |
3939
+----------------------------------+-------------------+
40-
| :attr:`Troop.upgrade_time` | :class:`TimeDelta`|
40+
| :attr:`Troop.upgrade_time` | :class:`TimeDelta` |
4141
+----------------------------------+-------------------+
4242
| :attr:`Troop.training_cost` | int |
4343
+----------------------------------+-------------------+
4444
| :attr:`Troop.training_resource` | :class:`Resource` |
4545
+----------------------------------+-------------------+
46-
| :attr:`Troop.training_time` |:class:`TimeDelta` |
46+
| :attr:`Troop.training_time` | :class:`TimeDelta` |
4747
+----------------------------------+-------------------+
4848
| :attr:`Troop.is_elixir_troop` | :class:`bool` |
4949
+----------------------------------+-------------------+
@@ -53,9 +53,9 @@ class Troop(DataContainer):
5353
+----------------------------------+-------------------+
5454
| :attr:`Troop.is_super_troop` | :class:`bool` |
5555
+----------------------------------+-------------------+
56-
| :attr:`Troop.cooldown` | :class:`TimeDelta`|
56+
| :attr:`Troop.cooldown` | :class:`TimeDelta` |
5757
+----------------------------------+-------------------+
58-
| :attr:`Troop.duration` | :class:`TimeDelta`|
58+
| :attr:`Troop.duration` | :class:`TimeDelta` |
5959
+----------------------------------+-------------------+
6060
| :attr:`Troop.min_original_level` | int |
6161
+----------------------------------+-------------------+
@@ -127,9 +127,6 @@ class Troop(DataContainer):
127127
village: str
128128
Either ``home`` or ``builderBase``, indicating which village this troop belongs to.
129129
"""
130-
__slots__ = ("id", "name", "range", "lab_level", "dps", "hitpoints", "ground_traget", "speed", "upgrade_cost",
131-
"upgrade_resource", "upgrade_time", "training_cost", "training_resource", "training_time",
132-
"cooldown", "duration", "min_original_level", "original_troop", "level", "max_level", "village")
133130
name: str
134131
level: int
135132
max_level: int

‎docs/code_overview/event.rst‎

Lines changed: 0 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -242,7 +242,6 @@ A few points to note:
242242
- Tags will be automatically corrected via the :meth:`coc.correct_tag` function.
243243

244244
- **Every tag** that is added to the client will be sent to **every callback for that event group**.
245-
246245
This makes for a much simpler internal design.
247246

248247

‎docs/code_overview/game_data.rst‎

Lines changed: 0 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,5 @@
11
.. currentmodule:: coc
22
.. _game_data:
3-
43
Game Data
54
=========
65
The following provides a detailed how-to for use of static game data that is loaded into coc.py.
@@ -23,7 +22,6 @@ Additionally, speed and memory consumption has been prioritised and optimised wh
2322

2423

2524
.. _initialising_game_data:
26-
2725
Initialising the Client
2826
-----------------------
2927

@@ -84,7 +82,6 @@ Although all efforts have been made to minimise overheads, some may prefer to on
8482
8583
8684
.. _loading_game_data:
87-
8885
Loading Game Data Manually
8986
--------------------------
9087

@@ -128,7 +125,6 @@ won't have metadata loaded. This is easy to fix, with the :meth:`Player.load_gam
128125

129126

130127
.. _initiated_v_uninitiated:
131-
132128
Initiated vs Uninitiated Objects
133129
--------------------------------
134130

@@ -142,7 +138,6 @@ with attributes.
142138

143139

144140
.. _initiated_objects:
145-
146141
Initiated Objects
147142
~~~~~~~~~~~~~~~~~
148143

@@ -202,7 +197,6 @@ Alternatively, you could use :meth:`Client.get_troop` and use the unititiated ob
202197

203198

204199
.. _uninitiated_objects:
205-
206200
Uninitiated Objects
207201
~~~~~~~~~~~~~~~~~~~
208202

‎docs/code_overview/models.rst‎

Lines changed: 4 additions & 53 deletions
Original file line numberDiff line numberDiff line change
@@ -27,13 +27,6 @@ Player Clan
2727
:private-members:
2828
:inherited-members:
2929

30-
Raid Clan
31-
^^^^^^^^^
32-
.. autoclass:: RaidClan()
33-
:members:
34-
:private-members:
35-
:inherited-members:
36-
3730
Ranked Clan
3831
^^^^^^^^^^^
3932
.. autoclass:: RankedClan()
@@ -81,7 +74,7 @@ Clan Member
8174
:inherited-members:
8275

8376
Ranked Player
84-
^^^^^^^^^^^^^
77+
^^^^^^^^^^^
8578
.. autoclass:: RankedPlayer()
8679
:members:
8780
:private-members:
@@ -101,13 +94,6 @@ Clan War Member
10194
:private-members:
10295
:inherited-members:
10396

104-
Raid Member
105-
^^^^^^^^^^^
106-
.. autoclass:: RaidMember()
107-
:members:
108-
:private-members:
109-
:inherited-members:
110-
11197
Player
11298
^^^^^^
11399
.. autoclass:: Player()
@@ -149,30 +135,6 @@ WarAttack
149135
:private-members:
150136

151137

152-
Raids
153-
~~~~~~
154-
155-
Raid Log Entry
156-
^^^^^^^^^^^^^^
157-
.. autoclass:: RaidLogEntry()
158-
:members:
159-
:private-members:
160-
:inherited-members:
161-
162-
Raid District
163-
^^^^^^^^^^^^^
164-
.. autoclass:: RaidDistrict()
165-
:members:
166-
:private-members:
167-
:inherited-members:
168-
169-
Raid Attack
170-
~~~~~~~~~~~~
171-
.. autoclass:: RaidAttack()
172-
:members:
173-
:private-members:
174-
175-
176138
Achievement
177139
~~~~~~~~~~~~
178140

@@ -190,27 +152,23 @@ Troop
190152

191153
Hero
192154
~~~~~
193-
.. autoclass:: Hero()
194-
:members:
195-
:private-members:
196-
197155

198-
Pet
199-
~~~~
200-
.. autoclass:: Pet()
156+
.. autoclass:: Hero()
201157
:members:
202158
:private-members:
203159

204160

205161
Spell
206162
~~~~~~
163+
207164
.. autoclass:: Spell()
208165
:members:
209166
:private-members:
210167

211168

212169
Location
213170
~~~~~~~~~
171+
214172
.. autoclass:: Location()
215173
:members:
216174
:private-members:
@@ -272,13 +230,6 @@ War League
272230
:members:
273231
:private-members:
274232

275-
Gold pass season
276-
~~~~~~~~~~~~~~~~~
277-
.. autoclass:: GoldPassSeason()
278-
:members:
279-
:private-members:
280-
:inherited-members:
281-
282233
Enumerations
283234
~~~~~~~~~~~~
284235

‎docs/discord-links/api-reference.rst‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
.. currentmodule:: coc
1+
.. current-module:: coc
22

33
API Reference
44
=============

‎docs/discord-links/discord-links-examples.rst‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
.. currentmodule:: coc
1+
.. current-module:: coc
22

33
Examples
44
========

0 commit comments

Comments
 (0)