Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Update wifi suspend documentation #1910

Merged
merged 2 commits into from Apr 16, 2017

Conversation

dnc40085
Copy link
Contributor

@dnc40085 dnc40085 commented Apr 15, 2017

This PR adds additional documentation to wifi module suggested by @TerryE in PR #1231

  • This PR is for the dev branch rather than for master.
  • This PR is compliant with the other contributing guidelines as well (if not, please describe why).

The extension developer FAQ has a section that warns the developer about the potential for the wifi subsystem to crash when executing functions that occupy the processor for longer than ~15ms. This PR adds this info to the wifi module documentation.

dnc40085 and others added 2 commits April 15, 2017 10:19
Added message about potential for wifi crashes caused by long running
functions

Modified description for wifi.resume() and wifi.suspend()
@marcelstoer marcelstoer added this to the 2.0.0-follow-up milestone Apr 16, 2017
@marcelstoer marcelstoer merged commit 0390269 into nodemcu:dev Apr 16, 2017
dnc40085 added a commit to dnc40085/nodemcu-firmware that referenced this pull request Apr 16, 2017
…u#1910

Modified documentation for:
  wifi.suspend()
  wifi.resume()
dnc40085 added a commit to dnc40085/nodemcu-firmware that referenced this pull request Apr 16, 2017
…u#1910

Modified documentation for:
  wifi.suspend()
  wifi.resume()
marcelstoer pushed a commit that referenced this pull request Apr 17, 2017
…1912)

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

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

* More wifi documentation changes
@dnc40085 dnc40085 deleted the dev_wifi_suspend_doc_update branch April 17, 2017 14:42
eiselekd pushed a commit to eiselekd/nodemcu-firmware that referenced this pull request Jan 7, 2018
* Added message about potential for wifi crashes and more

Added message about potential for wifi crashes caused by long running
functions

Modified description for wifi.resume() and wifi.suspend()
eiselekd pushed a commit to eiselekd/nodemcu-firmware that referenced this pull request Jan 7, 2018
…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
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

2 participants