Skip to content

Commit 971627f

Browse files
dnc40085marcelstoer
authored andcommitted
Fix admonition formatting error in wifi module docs added with #1910 (#1912)
* Fix admonition formatting error in wifi module docs added with #1910 Modified documentation for: wifi.suspend() wifi.resume() * More wifi documentation changes
1 parent 2f8b353 commit 971627f

File tree

1 file changed

+3
-6
lines changed

1 file changed

+3
-6
lines changed

docs/en/modules/wifi.md

Lines changed: 3 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -80,11 +80,10 @@ The current physical mode as one of `wifi.PHYMODE_B`, `wifi.PHYMODE_G` or `wifi.
8080

8181
## wifi.resume()
8282

83-
Wake up WiFi from suspended state or cancel pending wifi suspension
83+
Wake up WiFi from suspended state or cancel pending wifi suspension.
8484

8585
!!! note
86-
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)
87-
The resume callback also occurs asynchronously and will only execute after wifi has resumed normal operation.
86+
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.
8887

8988
#### Syntax
9089
`wifi.resume([resume_cb])`
@@ -262,12 +261,10 @@ none
262261
[`wifi.startsmart()`](#wifistartsmart)
263262

264263
## wifi.suspend()
265-
266264
Suspend Wifi to reduce current consumption.
267265

268266
!!! note
269-
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)
270-
The suspend callback also occurs asynchronously and will only execute after wifi has been successfully been suspended.
267+
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.
271268

272269

273270
#### Syntax

0 commit comments

Comments
 (0)