From 274adcd856c8d5f7d14fb513cb16aeba828f85b2 Mon Sep 17 00:00:00 2001 From: Jim Paris Date: Sat, 27 Jul 2013 19:51:07 -0400 Subject: [PATCH] Documentation updates --- nilmdb/client/client.py | 7 ++++--- 1 file changed, 4 insertions(+), 3 deletions(-) diff --git a/nilmdb/client/client.py b/nilmdb/client/client.py index ce4edd9..b097530 100644 --- a/nilmdb/client/client.py +++ b/nilmdb/client/client.py @@ -58,10 +58,11 @@ class Client(object): return self.http.get("dbinfo") def stream_list(self, path = None, layout = None, extended = False): - """Return a sorted list of [path,layout] lists. If 'path' or + """Return a sorted list of [path, layout] lists. If 'path' or 'layout' are specified, only return streams that match those - exact values. If 'extended' is True, the returned lists are - is [path,layout,extent_min,extent_max,total_rows,total_seconds].""" + exact values. If 'extended' is True, the returned lists have + extended info, e.g.: [path, layout, extent_min, extent_max, + total_rows, total_seconds.""" params = {} if path is not None: params["path"] = path