add missing docstrings (#53)

Author: circuitsacul

hikari_clusters/brain.py

@@ -150,7 +150,8 @@ def waiting_for(self, value: tuple[int, int] | None) -> None:
         self._waiting_for = value
 
     def get_info(self) -> BrainInfo:
-        # <<<docstring from superclass>>>
+        # <<<docstring from BaseClient>>>
+
         assert self.ipc.uid
         return BrainInfo(uid=self.ipc.uid)
 
@@ -167,15 +168,17 @@ def sigstop(*args: Any, **kwargs: Any) -> None:
         loop.run_until_complete(self.close())
 
     async def start(self) -> None:
-        # <<<docstring from superclass>>>
+        # <<<docstring from BaseClient>>>
+
         self.stop_future = asyncio.Future()
 
         await self.server.start()
         await super().start()
         self.tasks.create_task(self._main_loop())
 
     async def close(self) -> None:
-        # <<<docstring from superclass>>>
+        # <<<docstring from BaseClient>>>
+
         self.ipc.stop()
         await self.ipc.close()
 

hikari_clusters/cluster.py

@@ -88,6 +88,8 @@ def __init__(
         self.bot.cluster = self  # type: ignore
 
     def get_info(self) -> ClusterInfo:
+        # <<<docstring from BaseClient>>>
+
         assert self.ipc.uid
         return ClusterInfo(
             self.ipc.uid, self.server_uid, self.shard_ids, self.ready
@@ -118,7 +120,8 @@ def shard_count(self) -> int:
         return self._shard_count
 
     async def start(self, **kwargs: Any) -> None:
-        # <<<docstring from superclass>>>
+        # <<<docstring from BaseClient>>>
+
         await super().start()
 
         kwargs["shard_count"] = self.shard_count
@@ -127,9 +130,9 @@ async def start(self, **kwargs: Any) -> None:
         await self.bot.start(**kwargs)
 
     async def close(self) -> None:
-        # <<<docstring from superclass>>>
-        await self.bot.close()
+        # <<<docstring from BaseClient>>>
 
+        await self.bot.close()
         await super().close()
 
 

hikari_clusters/info_classes.py

@@ -44,16 +44,22 @@ def __init_subclass__(cls) -> None:
         BaseInfo._info_classes[cls._info_class_id] = cls
 
     def asdict(self) -> dict[str, Any]:
+        """Convert this info class to a dictionary."""
+
         dct = asdict(self)
         dct["_info_class_id"] = self._info_class_id
         return dct
 
     @staticmethod
     def fromdict(data: dict[str, Any]) -> BaseInfo:
+        """Convert a dictionary back into its info class."""
+
         cls = BaseInfo._info_classes[data.pop("_info_class_id")]
         return cls(**data)
 
     def __int__(self) -> int:
+        """The IPC UID of the client this info class represents."""
+
         return self.uid
 
 
@@ -105,6 +111,8 @@ def get_cluster_id(shard_id: int, shards_per_cluster: int) -> int:
 
 @dataclass
 class BrainInfo(BaseInfo):
+    """A representation of a :class:`~brain.Brain`."""
+
     _info_class_id = 2
     uid: int
     """The ipc uid of the brain."""

hikari_clusters/server.py

@@ -103,6 +103,8 @@ def clusters(self) -> list[ClusterInfo]:
         ]
 
     def get_info(self) -> ServerInfo:
+        # <<<docstring from BaseClient>>>
+
         assert self.ipc.uid
         return ServerInfo(self.ipc.uid, [c.uid for c in self.clusters])
 
@@ -119,9 +121,9 @@ def sigstop(*args: Any, **kwargs: Any) -> None:
         loop.run_until_complete(self.close())
 
     async def start(self) -> None:
-        # <<<docstring from superclass>>>
-        await super().start()
+        # <<<docstring from BaseClient>>>
 
+        await super().start()
         self.tasks.create_task(self._loop_cleanup_processes())
 
     async def _loop_cleanup_processes(self) -> None: