Merge pull request #7265 from jepler/wifi-monitor-docs

Fix documentation of wifi.Monitor
This commit is contained in:
Scott Shawcroft 2022-11-28 16:23:40 -08:00 committed by GitHub
commit 81afe05811
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
1 changed files with 22 additions and 26 deletions

View File

@ -44,7 +44,6 @@
//|
//| """
//| ...
//|
STATIC mp_obj_t wifi_monitor_make_new(const mp_obj_type_t *type, size_t n_args, size_t n_kw, const mp_obj_t *all_args) {
enum { ARG_channel, ARG_queue };
static const mp_arg_t allowed_args[] = {
@ -103,7 +102,6 @@ MP_PROPERTY_GETTER(wifi_monitor_queue_obj,
//| def deinit(self) -> None:
//| """De-initialize `wifi.Monitor` singleton."""
//| ...
//|
STATIC mp_obj_t wifi_monitor_obj_deinit(mp_obj_t self_in) {
common_hal_wifi_monitor_deinit(self_in);
return mp_const_none;
@ -113,7 +111,6 @@ STATIC MP_DEFINE_CONST_FUN_OBJ_1(wifi_monitor_deinit_obj, wifi_monitor_obj_deini
//| def lost(self) -> int:
//| """Returns the packet loss count. The counter resets after each poll."""
//| ...
//|
STATIC mp_obj_t wifi_monitor_obj_get_lost(mp_obj_t self_in) {
return common_hal_wifi_monitor_get_lost(self_in);
}
@ -122,7 +119,6 @@ MP_DEFINE_CONST_FUN_OBJ_1(wifi_monitor_lost_obj, wifi_monitor_obj_get_lost);
//| def queued(self) -> int:
//| """Returns the packet queued count."""
//| ...
//|
STATIC mp_obj_t wifi_monitor_obj_get_queued(mp_obj_t self_in) {
if (common_hal_wifi_monitor_deinited()) {
return mp_obj_new_int_from_uint(0);