From: Alfredo Deza <alfredo.deza@inktank.com>
Date: Wed, 27 Aug 2014 14:40:20 +0000 (-0400)
Subject: add example to docstring for ip_addresses
X-Git-Tag: v1.5.13~9
X-Git-Url: http://git-server-git.apps.pok.os.sepia.ceph.com/?a=commitdiff_plain;h=11e3e4057f4ee9a697b7b5093d429dcec53ec44c;p=ceph-deploy.git

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 eff8f47..84ba18d 100644
--- 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)