Added docstrings for wifi module #262
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
Signed-off-by: Iván Sánchez Ortega <ivan@sanchezortega.es>
|
❤️ thanks for helping out documenting stuff ! |
ivmarkov
requested changes
Jun 1, 2023
| @@ -1625,6 +1664,8 @@ fn matches_wifi_event(event: &WifiEvent) -> bool { | |||
| ) | |||
| } | |||
|
|
|||
| /// Wraps a [`WifiDriver`] or [`EspWifi`], and offers strictly synchronous (blocking) | |||
| /// function calls for their functionality. | |||
There was a problem hiding this comment.
You might want to add an example here in that wrapping is possible both by moving the WifiDriver / EspWifi instance into BlockingWifi, as well as by mutable borrowing it (i.e. &mut wifi_driver), where the latter allows one to re-use the driver elsewhere once BlockingWifi is dropped.
There was a problem hiding this comment.
Alas, I wasn't even aware that BlockingWifi was wrapping a EspWifi instance until I read the source code - I don't have a use case where I'd reuse the driver by dropping BlockingWifi, much less I feel confident to write a reliable example.
I'd rather leave this for a future improvement.
Signed-off-by: Iván Sánchez Ortega <ivan@sanchezortega.es>
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.
I recently became slightly frustrated with some of the documentation of the Wifi module. I noted that
WifiDriverjust calls functions fromesp_idf_sys(which do have more detailed notes about their behaviour and preconditions), and also noted thatEspWifi,BlockingWifiandAsyncWifiare just wrappers, adding links to the functions being wrapped.