From 11e3e4057f4ee9a697b7b5093d429dcec53ec44c Mon Sep 17 00:00:00 2001 From: Alfredo Deza Date: Wed, 27 Aug 2014 10:40:20 -0400 Subject: [PATCH] add example to docstring for ip_addresses Signed-off-by: Alfredo Deza --- ceph_deploy/util/net.py | 6 ++++++ 1 file changed, 6 insertions(+) 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) -- 2.47.3