docs: timeout unit is added

zigbang · Oct 4, 2022 · 193154b · 193154b
1 parent a1b6611
commit 193154b
Show file tree

Hide file tree

Showing 2 changed files with 2 additions and 2 deletions.
diff --git a/packages/iot-device-sdk/src/subDevice.ts b/packages/iot-device-sdk/src/subDevice.ts
@@ -6,7 +6,7 @@ import { TuyaSdkBridge } from './common';
  * Callback function offer sub device detail information.
  *
  * @param gw_id - gateway id that zigbee device is connected to
- * @param timeout - maximum timeout for sub devices registration
+ * @param timeout - maximum timeout for sub devices registration, unit is seconds
  * @param callback - Callback function for get information about registration
  *
  * @returns Function's result

diff --git a/packages/iot-device-sdk/src/wiredGw.ts b/packages/iot-device-sdk/src/wiredGw.ts
@@ -50,7 +50,7 @@ export function stopSearchWiredGW() {
  *
  * @param gw_id - gateway id for registration
  * @param product_id - product id for registration
- * @param timeout - maximum timeout for registration
+ * @param timeout - maximum timeout for registration, unit is seconds
  *
  * @returns Success and failure details as a result
  *  - in case OK: [ref](https://github.com/iot-device-sdk/blob/main/packages/iot-device-sdk/sample-gw.md)