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

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

Merged
merged 2 commits into from
Apr 17, 2017

Conversation

dnc40085
Copy link
Contributor

@dnc40085 dnc40085 commented Apr 16, 2017

Fixes documentation error introduced with PR #1910

  • 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).

I discovered an additional error in the admonition formatting for the functions wifi.suspend() and wifi.resume()

…u#1910

Modified documentation for:
  wifi.suspend()
  wifi.resume()
@dnc40085 dnc40085 force-pushed the dev_1910_admonition_formatting_fix branch from 524c66b to e559160 Compare April 16, 2017 23:53
@dnc40085
Copy link
Contributor Author

@marcelstoer Is there a way to preview the documentation before merge? I tried installing RTD locally and I could not get it to work.

@djphoenix
Copy link
Contributor

@dnc40085, in your shell (with pip installed):

$ pip install mkdocs
$ mkdocs serve

then open your browser with link printed out.

@dnc40085
Copy link
Contributor Author

@djphoenix that worked perfectly, thank you very much.

@marcelstoer marcelstoer merged commit 971627f into nodemcu:dev Apr 17, 2017
@marcelstoer marcelstoer added this to the 2.0.0-follow-up milestone Apr 17, 2017
@dnc40085 dnc40085 deleted the dev_1910_admonition_formatting_fix branch April 17, 2017 14:43
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

3 participants