Remove OverrideDoc and just copy-paste them for now. Add doc to cached property members.

Author: mathsman5133

coc/abc.py

@@ -30,47 +30,7 @@
     from .players import Player
 
 
-class OverrideDoc(type):
-    """Helper metaclass to make Sphinx recognise attributes from base classes.
-
-    This just overrides the object's docstring and injects any documented attributes from the base classes.
-    """
-
-    def __new__(cls, *args, **kwargs):
-        _, bases, _ = args
-        new_cls = super().__new__(cls, *args, **kwargs)
-
-        for obj in bases:
-            if obj.__doc__ is None:
-                continue
-            if new_cls.__doc__ is None:
-                continue
-            if "Attributes" not in obj.__doc__:
-                continue
-
-            try:
-                doc = obj.__doc__.split("Attributes")[1].split("\n\n")[0]
-            except (KeyError, AttributeError):
-                continue
-
-            if "Attributes" not in new_cls.__doc__:
-                new_cls.__doc__ += "\nAttributes\n----------\n" + doc.replace("----------", "")
-            else:
-                try:
-                    insert = new_cls.__doc__.index("Attributes")
-                except ValueError:
-                    return new_cls
-
-                # fmt: off
-                new_cls.__doc__ = (
-                    new_cls.__doc__[:insert + 25] + doc.replace("----------", "") + new_cls.__doc__[insert + 25:]
-                )
-                # fmt: on
-
-        return new_cls
-
-
-class BaseClan(metaclass=OverrideDoc):
+class BaseClan:
     """An ABC that implements some common operations on clans, regardless of type.
 
     Attributes
@@ -142,7 +102,7 @@ def get_detailed_members(self, cls: Type["Player"] = None) -> AsyncIterator["Pla
         return PlayerIterator(self._client, (p.tag for p in self.members), cls=cls)
 
 
-class BasePlayer(metaclass=OverrideDoc):
+class BasePlayer:
     """An ABC that implements some common operations on players, regardless of type.
 
     Attributes

coc/clans.py

@@ -35,6 +35,14 @@ class RankedClan(BaseClan):
 
     Attributes
     ----------
+    tag: :class:`str`
+        The clan's tag
+    name: :class:`str`
+        The clan's name
+    badge: :class:`Badge`
+        The clan's badge
+    level: :class:`int`
+        The clan's level.
     location: :class:`Location`
         The clan's location.
     member_count: :class:`int`
@@ -78,6 +86,14 @@ class Clan(BaseClan):
 
     Attributes
     ----------
+    tag: :class:`str`
+        The clan's tag
+    name: :class:`str`
+        The clan's name
+    badge: :class:`Badge`
+        The clan's badge
+    level: :class:`int`
+        The clan's level.
     type: :class:`str`
         The clan's type for accepting members.
         This could be ``open``, ``inviteOnly`` or ``closed``.

coc/player_clan.py

@@ -27,4 +27,15 @@
 
 class PlayerClan(BaseClan):
     """Represents a clan that belongs to a player.
+
+    Attributes
+    ----------
+    tag: :class:`str`
+        The clan's tag
+    name: :class:`str`
+        The clan's name
+    badge: :class:`Badge`
+        The clan's badge
+    level: :class:`int`
+        The clan's level.
     """

coc/players.py

@@ -52,6 +52,10 @@ class ClanMember(BasePlayer):
 
     Attributes
     ----------
+    tag: :class:`str`
+        The player's tag
+    name: :class:`str`
+        The player's name
     clan: Optional[:class:`Clan`]
         The player's clan. If the player is clanless, this will be ``None``.
     role: :class:`Role`

coc/utils.py

@@ -328,6 +328,7 @@ class _CachedProperty(Generic[T, T_co]):
     def __init__(self, name: str, function: Callable[[T], T_co]) -> None:
         self.name = name
         self.function = function
+        self.__doc__ = getattr(function, '__doc__')
 
     def __get__(self, instance: T, owner: Type[T]) -> T_co:
         try:

coc/war_clans.py

@@ -48,6 +48,14 @@ class WarClan(BaseClan):
 
     Attributes
     ----------
+    tag: :class:`str`
+        The clan's tag
+    name: :class:`str`
+        The clan's name
+    badge: :class:`Badge`
+        The clan's badge
+    level: :class:`int`
+        The clan's level.
     stars:
         :class:`int`: Number of stars by clan this war.
     destruction:
@@ -157,7 +165,19 @@ def get_member(self, tag: str) -> typing.Optional[ClanWarMember]:
 
 
 class ClanWarLeagueClan(BaseClan):
-    """Represents a Clan War League Clan."""
+    """Represents a Clan War League Clan.
+
+    Attributes
+    ----------
+    tag: :class:`str`
+        The clan's tag
+    name: :class:`str`
+        The clan's name
+    badge: :class:`Badge`
+        The clan's badge
+    level: :class:`int`
+        The clan's level.
+    """
 
     __slots__ = BaseClan.__slots__ + ("_cs_members", "_iter_members")
 

coc/war_members.py

@@ -38,6 +38,10 @@ class ClanWarMember(BasePlayer):
 
     Attributes
     ----------
+    tag: :class:`str`
+        The player's tag
+    name: :class:`str`
+        The player's name
     town_hall:
         :class:`int`: The member's townhall level.
     map_position:
@@ -138,6 +142,10 @@ class ClanWarLeagueClanMember(BasePlayer):
 
     Attributes
     ----------
+    tag: :class:`str`
+        The player's tag
+    name: :class:`str`
+        The player's name
     town_hall: :class:`int`
         The player's town hall level.
     """