Skip to content

Commit

Permalink
Fix admonition formatting error in wifi module docs added with nodemc…
Browse files Browse the repository at this point in the history
…u#1910 (nodemcu#1912)

* Fix admonition formatting error in wifi module docs added with nodemcu#1910

Modified documentation for:
  wifi.suspend()
  wifi.resume()

* More wifi documentation changes
  • Loading branch information
dnc40085 authored and Konrad Eisele committed Jan 7, 2018
1 parent dd82fb4 commit b0ad465
Showing 1 changed file with 3 additions and 6 deletions.
9 changes: 3 additions & 6 deletions docs/en/modules/wifi.md
Original file line number Diff line number Diff line change
Expand Up @@ -80,11 +80,10 @@ The current physical mode as one of `wifi.PHYMODE_B`, `wifi.PHYMODE_G` or `wifi.

## 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])`
Expand Down Expand Up @@ -262,12 +261,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 executes asynchronously and will only execute after wifi has been successfully been suspended.


#### Syntax
Expand Down

0 comments on commit b0ad465

Please sign in to comment.