update doc per review

2020-12-03 22:05:02 -05:00 · 2020-12-03 22:05:02 -05:00 · 2f0e676fcb
parent 57fa6bece8
commit 2f0e676fcb
1 changed files with 3 additions and 1 deletions
--- a/shared-bindings/wifi/Radio.c
+++ b/shared-bindings/wifi/Radio.c
@ -48,7 +48,9 @@
 //|

 //|     enabled: bool
-//|     """True when the wifi radio is enabled."""
+//|     """``True`` when the wifi radio is enabled.
+//|     If you set the value to ``False``, any open sockets will be closed.
+//|     """
 //|
 STATIC mp_obj_t wifi_radio_get_enabled(mp_obj_t self) {
    return mp_obj_new_bool(common_hal_wifi_radio_get_enabled(self));