From 3655a31ac1838e8e2a1ced63a22148be7fec8b1e Mon Sep 17 00:00:00 2001 From: Matt Martz Date: Tue, 27 May 2014 09:31:04 -0500 Subject: [PATCH] Add section about inconsistency in README.rst --- README.rst | 20 ++++++++++++++++++++ 1 file changed, 20 insertions(+) diff --git a/README.rst b/README.rst index e068d2c..6da05fe 100644 --- a/README.rst +++ b/README.rst @@ -91,3 +91,23 @@ Usage --source SOURCE Source IP address to bind to --version Show the version number and exit +Inconsistency +------------- + +It is not a goal of this application to be a reliable latency reporting tool. + +Latency reported by this tool should not be relied on as a value indicative of ICMP +style latency. It is a relative value used for determining the lowest latency server +for performing the actual speed test against. + +There is the potential for this tool to report results inconsistent with Speedtest.net. +There are several concepts to be aware of that factor into the potential inconsistency: + +1. Speedtest.net has migrated to using pure socket tests instead of HTTP based tests +2. This application is written in Python +3. Different versions of Python will execute certain parts of the code faster than others +4. CPU and Memory capacity and speed will play a large part in inconsistency between + Speedtest.net and even other machines on the same network + +Issues relating to inconsistencies will be closed as wontfix and without +additional reason or context.