From 301fcad36bc24f8a1ea971aa856efc2036e8713e Mon Sep 17 00:00:00 2001 From: Ivan Grokhotkov Date: Tue, 22 Aug 2017 14:20:19 +0800 Subject: [PATCH] docs: wifi: use list instead of nested table Latex backend does not support nested tables, which caused documentation build to fail on readthedocs. --- docs/api-guides/wifi.rst | 26 +++++++------------------- 1 file changed, 7 insertions(+), 19 deletions(-) diff --git a/docs/api-guides/wifi.rst b/docs/api-guides/wifi.rst index 800f8ae05..1c757bf7c 100644 --- a/docs/api-guides/wifi.rst +++ b/docs/api-guides/wifi.rst @@ -494,25 +494,13 @@ The scan type and other scan attributes are configured by esp_wifi_scan_start. T | | in the table below. Here, min is short for scan | | | time.active.min and max is short for scan_time.active.max. | | | | -| | +----+----+------------------------------------------------+ | -| | | min| max| Description | | -| | +====+====+================================================+ | -| | | 0 | 0 | scan dwells on each channel for 120 ms. | | -| | | | | | | -| | +----+----+------------------------------------------------+ | -| | | >0 | 0 | scan dwells on each channel for 120 ms. | | -| | | | | | | -| | +----+----+------------------------------------------------+ | -| | | >0 | >0 | The minimum time the scan dwells on each | | -| | | | | channel is min milliseconds. If no AP is found | | -| | | | | during this time frame, the scan switches | | -| | | | | to the next channel; otherwise, the scan dwells| | -| | | | | on the channel for max milliseconds. | | -| | | | | | | -| | +----+----+------------------------------------------------+ | -| | | 0 | >0 | The scan dwells on each channel for max | | -| | | | | milliseconds. | | -| | +----+----+------------------------------------------------+ | +| | - min=0, max=0: scan dwells on each channel for 120 ms. | +| | - min>0, max=0: scan dwells on each channel for 120 ms. | +| | - min=0, max>0: scan dwells on each channel for ``max`` ms. | +| | - min>0, max>0: the minimum time the scan dwells on each | +| | channel is ``min`` ms. If no AP is found during this time | +| | frame, the scan switches to the next channel. Otherwise, | +| | the scan dwells on the channel for ``max`` ms. | | | | | | If you want to improve the performance of the | | | the scan, you can try to modify these two parameters. |