summaryrefslogtreecommitdiff
path: root/shared-bindings
diff options
context:
space:
mode:
authorDan Halbert <halbert@halwitz.org>2020-12-03 22:05:02 -0500
committerDan Halbert <halbert@halwitz.org>2020-12-03 22:06:02 -0500
commit2f0e676fcba318bbfcd39e6c50e75d6aeb739ac6 (patch)
treed7720426428ce273b238ba02bf5b4cfedf98665b /shared-bindings
parent57fa6bece8fb841de10aaa6e96ced59749e6c566 (diff)
update doc per review
Diffstat (limited to 'shared-bindings')
-rw-r--r--shared-bindings/wifi/Radio.c4
1 files changed, 3 insertions, 1 deletions
diff --git a/shared-bindings/wifi/Radio.c b/shared-bindings/wifi/Radio.c
index d9d7dd5b5..edbd9fd2f 100644
--- 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));