From e559160a85dee935d6aede928d7ad7d776bc4013 Mon Sep 17 00:00:00 2001 From: dnc40085 Date: Sun, 16 Apr 2017 16:47:18 -0700 Subject: [PATCH 1/2] Fix admonition formatting error in wifi module docs added with #1910 Modified documentation for: wifi.suspend() wifi.resume() --- docs/en/modules/wifi.md | 8 ++------ 1 file changed, 2 insertions(+), 6 deletions(-) diff --git a/docs/en/modules/wifi.md b/docs/en/modules/wifi.md index c16288e3f7..4bb6f5360b 100644 --- a/docs/en/modules/wifi.md +++ b/docs/en/modules/wifi.md @@ -79,12 +79,10 @@ The current physical mode as one of `wifi.PHYMODE_B`, `wifi.PHYMODE_G` or `wifi. [`wifi.setphymode()`](#wifisetphymode) ## wifi.resume() - Wake up WiFi from suspended state or cancel pending wifi suspension !!! note - Wifi resume occurs asynchronously, this means that the resume request will only be processed when control of the processor is passed back to the SDK (after MyResumeFunction() has completed) - The resume callback also occurs asynchronously and will only execute after wifi has resumed normal operation. + Wifi resume occurs asynchronously, this means that the resume request will only be processed when control of the processor is passed back to the SDK (after MyResumeFunction() has completed). The resume callback also occurs asynchronously and will only execute after wifi has resumed normal operation. #### Syntax `wifi.resume([resume_cb])` @@ -262,12 +260,10 @@ none [`wifi.startsmart()`](#wifistartsmart) ## wifi.suspend() - Suspend Wifi to reduce current consumption. !!! note - Wifi suspension occurs asynchronously, this means that the suspend request will only be processed when control of the processor is passed back to the SDK (after MySuspendFunction() has completed) - The suspend callback also occurs asynchronously and will only execute after wifi has been successfully been suspended. + Wifi suspension occurs asynchronously, this means that the suspend request will only be processed when control of the processor is passed back to the SDK (after MySuspendFunction() has completed). The suspend callback also occurs asynchronously and will only execute after wifi has been successfully been suspended. #### Syntax From c4f6d33828ec5b9a8e78c490d5dcb13cd9e4434f Mon Sep 17 00:00:00 2001 From: dnc40085 Date: Sun, 16 Apr 2017 22:29:50 -0700 Subject: [PATCH 2/2] More wifi documentation changes --- docs/en/modules/wifi.md | 7 ++++--- 1 file changed, 4 insertions(+), 3 deletions(-) diff --git a/docs/en/modules/wifi.md b/docs/en/modules/wifi.md index 4bb6f5360b..7e9d83448b 100644 --- a/docs/en/modules/wifi.md +++ b/docs/en/modules/wifi.md @@ -79,10 +79,11 @@ The current physical mode as one of `wifi.PHYMODE_B`, `wifi.PHYMODE_G` or `wifi. [`wifi.setphymode()`](#wifisetphymode) ## wifi.resume() -Wake up WiFi from suspended state or cancel pending wifi suspension + +Wake up WiFi from suspended state or cancel pending wifi suspension. !!! note - Wifi resume occurs asynchronously, this means that the resume request will only be processed when control of the processor is passed back to the SDK (after MyResumeFunction() has completed). The resume callback also occurs asynchronously and will only execute after wifi has resumed normal operation. + Wifi resume occurs asynchronously, this means that the resume request will only be processed when control of the processor is passed back to the SDK (after MyResumeFunction() has completed). The resume callback also executes asynchronously and will only execute after wifi has resumed normal operation. #### Syntax `wifi.resume([resume_cb])` @@ -263,7 +264,7 @@ none Suspend Wifi to reduce current consumption. !!! note - Wifi suspension occurs asynchronously, this means that the suspend request will only be processed when control of the processor is passed back to the SDK (after MySuspendFunction() has completed). The suspend callback also occurs asynchronously and will only execute after wifi has been successfully been suspended. + Wifi suspension occurs asynchronously, this means that the suspend request will only be processed when control of the processor is passed back to the SDK (after MySuspendFunction() has completed). The suspend callback also executes asynchronously and will only execute after wifi has been successfully been suspended. #### Syntax