Update wifi event monitor documentation #1889
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Added a note to `wifi.eventmon.register()` and `wifi.sta.eventmonreg()`
dnc40085
force-pushed
the
dev_eventmon_doc_update
branch
from
9615615 to
62206e5
Compare
marcelstoer
reviewed
Mar 29, 2017
docs/en/modules/wifi.md
Outdated
| @@ -398,6 +398,9 @@ none | |||
|
|
|||
| Registers callbacks for WiFi station status events. | |||
|
|
|||
| !!! note | |||
| Please update your program to use the [`wifi.eventmon`](#wifieventmon-module) API, as the `wifi.sta.eventmon___()` API is to be depreciated. | |||
There was a problem hiding this comment.
is to be depreciated
- That should be "deprecated" I guess?
- "to be" confuses me a little here, is it deprecated or not?
There was a problem hiding this comment.
That should be "deprecated" I guess?
"to be" confuses me a little here, is it deprecated or not?
You're right, I found this Wikipedia page about deprecation, and it is indeed "deprecated".
|
So, it seems those functions really are deprecated (sorry, didn't know). How about adding Example usage: |
Done |
eiselekd
pushed a commit
to eiselekd/nodemcu-firmware
that referenced
this pull request
Jan 7, 2018
* Update wifi event monitor documentation Added a note to `wifi.eventmon.register()` and `wifi.sta.eventmonreg()` * Add deprecation note to `wifi.sta.eventMonReg()`
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Update wifi event monitor documentation.
Fixes #1737.
devbranch rather than formaster.A lack of information about when the wifi event monitor callbacks should be registered is causing confusion, the new information provided should help to clarify the function of the event monitor .