[tor-commits] [sbws/master] docs: explain how is selected the data to download

[juga at torproject.org]

commit 81e2d40eca3a0588bb12e8174bab1306a8c473b2
Author: juga0 <juga at riseup.net>
Date:   Thu Feb 7 11:02:41 2019 +0000

    docs: explain how is selected the data to download
---
 docs/source/specification.rst | 14 ++++++++++++++
 1 file changed, 14 insertions(+)

diff --git a/docs/source/specification.rst b/docs/source/specification.rst
index 56bd8b1..e2b687b 100644
--- a/docs/source/specification.rst
+++ b/docs/source/specification.rst
@@ -150,6 +150,20 @@ Selecting a second relay
 
 Source code: :func:`sbws.core.scanner.measure_relay`
 
+Selecting the data to download
+~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+
+#. While the downloaded data is smaller than 1GB or the number of download
+   is minor than 5:
+#. Randomly, select a 16MiB range.
+#. If it takes less than 5 seconds, select a bigger range and don't keep any
+   information.
+#. If it takes more than 10 seconds, select an smaller range and don't keep any
+   information.
+#. Store the number of bytes downloaded and the time it took.
+
+Source code: :func:`sbws.core.scanner._should_keep_result`
+
 Simple result storage
 ~~~~~~~~~~~~~~~~~~~~~