docs: fix issues for docs warnings

This commit is contained in:
Wilfred Allyn
2025-01-16 05:36:15 -05:00
committed by Brett Rowan
parent 88b4d2cac3
commit e86f2b62c5
3 changed files with 6 additions and 9 deletions

View File

@@ -151,7 +151,7 @@ class LUXMiner(LuxOSFirmware):
bool: True if the firmware upgrade was successfully initiated, False otherwise. bool: True if the firmware upgrade was successfully initiated, False otherwise.
""" """
try: try:
await self.rpc.upgraderun() await self.rpc.updaterun()
logging.info(f"{self.ip}: Firmware upgrade initiated successfully.") logging.info(f"{self.ip}: Firmware upgrade initiated successfully.")
return True return True

View File

@@ -574,9 +574,6 @@ class LUXMinerRPCAPI(BaseMinerRPCAPI):
<details> <details>
<summary>Expand</summary> <summary>Expand</summary>
Parameters:
session_id: Session id from the logon command.
Returns: Returns:
Confirmation of logging off a session. Confirmation of logging off a session.
</details> </details>
@@ -844,7 +841,7 @@ class LUXMinerRPCAPI(BaseMinerRPCAPI):
""" """
return await self.send_privileged_command("voltageset", board_n, voltage) return await self.send_privileged_command("voltageset", board_n, voltage)
async def upgraderun(self): async def updaterun(self) -> dict:
""" """
Send the 'updaterun' command to the miner. Send the 'updaterun' command to the miner.

View File

@@ -268,11 +268,11 @@ class AuradineWebAPI(BaseWebAPI):
""" """
return await self.send_command("mode") return await self.send_command("mode")
async def set_mode(self, **kwargs) -> dict: async def set_mode(self, **kwargs: Any) -> dict:
"""Set the operational mode of the Auradine miner. """Set the operational mode of the Auradine miner.
Args: Args:
**kwargs: Mode settings specified as keyword arguments. **kwargs (Any): Mode settings specified as keyword arguments.
Returns: Returns:
dict: A dictionary indicating the result of the mode setting operation. dict: A dictionary indicating the result of the mode setting operation.
@@ -287,11 +287,11 @@ class AuradineWebAPI(BaseWebAPI):
""" """
return await self.send_command("network") return await self.send_command("network")
async def set_network(self, **kwargs) -> dict: async def set_network(self, **kwargs: Any) -> dict:
"""Set the network configuration of the Auradine miner. """Set the network configuration of the Auradine miner.
Args: Args:
**kwargs: Network settings specified as keyword arguments. **kwargs (Any): Network settings specified as keyword arguments.
Returns: Returns:
dict: A dictionary indicating the result of the network configuration. dict: A dictionary indicating the result of the network configuration.