Refactor docstrings and cli help

bdragon300 · Oct 26, 2024 · aa8887c · aa8887c
1 parent 9186159
commit aa8887c
Show file tree

Hide file tree

Showing 19 changed files with 502 additions and 431 deletions.
diff --git a/docs/data_tables.md b/docs/data_tables.md
@@ -59,7 +59,7 @@ print(my_user.dict)
 ```
 
 Sometimes you may want to get the raw string data (i.e. how it stores on device) that are sent to a device on saving
-an object. Use `raw_data` property for it:
+an object. Use `raw_data` property for that:
 
 ```python
 from pyzkaccess.tables import User

diff --git a/docs/overview.md b/docs/overview.md
@@ -29,5 +29,4 @@ NOTE: the default factory IP address of C3 devices is `192.168.1.201`.
 - Restart a device
 - Download/upload files from PC to/from a device
 - Cancel alarm function
-- Reset the IP address using the broadcast method for a device available in the same local network. Useful when
-  device IP is unknown.
+- Reset the IP address by MAC address.
diff --git a/pyzkaccess/aux_input.py b/pyzkaccess/aux_input.py
@@ -21,7 +21,7 @@ def _specific_event_log(self) -> EventLog:
 
 
 class AuxInput(AuxInputInterface):
-    """Concrete auxiliary input"""
+    """An auxiliary input"""
 
     def __init__(self, sdk: ZKSDK, event_log: EventLog, number: int):
         self.number = number
@@ -50,9 +50,7 @@ def __repr__(self) -> str:
 
 
 class AuxInputList(AuxInputInterface, UserTuple[AuxInput]):
-    """Collection of aux input objects which is used to perform group
-    operations over multiple aux inputs
-    """
+    """Auxiliary input collection for group operations"""
 
     def __init__(self, sdk: ZKSDK, event_log: EventLog, aux_inputs: Iterable[AuxInput] = ()):
         super().__init__(aux_inputs)