add example to docstring for ip_addresses

Signed-off-by: Alfredo Deza <alfredo.deza@inktank.com>

diff --git a/ceph_deploy/util/net.py b/ceph_deploy/util/net.py
index eff8f47d37ff5e83e00f2043791b685bf72e45ea..84ba18d8787fa9c80214edde5da20c5c8926dd82 100644 (file)
--- a/ceph_deploy/util/net.py
+++ b/ceph_deploy/util/net.py
@@ -67,6 +67,12 @@ def ip_addresses(conn, interface=None, include_loopback=False):
     Returns a list of IPv4 addresses assigned to the host. 127.0.0.1 is
     ignored, unless 'include_loopback=True' is indicated. If 'interface' is
     provided, then only IP addresses from that interface will be returned.
+
+    Example output looks like::
+
+        >>> ip_addresses(conn)
+        >>> ['192.168.1.111', '10.0.1.12']
+
     """
     ret = set()
     ifaces = linux_interfaces(conn)