update unknown API docstring

2022-03-14 14:12:31 -06:00
parent d8e59afee0
commit 2380b94db1
1 changed files with 6 additions and 0 deletions
--- a/API/unknown.py
+++ b/API/unknown.py
@@ -2,6 +2,12 @@ from API import BaseMinerAPI


 class UnknownAPI(BaseMinerAPI):
+    """An abstraction of an API for a miner which is unknown.
+
+    This class is designed to try to be a intersection of as many miner APIs
+    and API commands as possible (API ⋂ API), to ensure that it can be used
+    with as many APIs as possible.
+    """
    def __init__(self, ip, port=4028):
        super().__init__(ip, port)