[tor-commits] [onionperf/master] Adds docstrings for the function get_ip_address()

[irl at torproject.org]

commit f1b89b9506b6827f8033f83a18dadb1d7b396a69
Author: Ana Custura <ana at netstat.org.uk>
Date:   Tue Mar 5 17:24:26 2019 +0100

    Adds docstrings for the function get_ip_address()
---
 onionperf/util.py | 5 +++++
 1 file changed, 5 insertions(+)

diff --git a/onionperf/util.py b/onionperf/util.py
index c35e638..c7d615e 100644
--- a/onionperf/util.py
+++ b/onionperf/util.py
@@ -134,6 +134,11 @@ def get_ip_address():
     check.torproject.org service. If it is not possible to reach the service,
     or to parse the result recieved, it will fall back to determining the local
     IP address used for outbound connections.
+
+    :returns: string
+    :raises IOError: In case of network or DNS failure, reaching check.torproject.org \
+    will fail. The user is notified this may affect measurements and we fail over to\
+    calling util.find_ip_address_local()
     """
     ip_address = None
     try: