Skip to content

Commit 2787a0e

Browse files
committed
updated summary() docstring
1 parent a2e39f9 commit 2787a0e

File tree

1 file changed

+7
-0
lines changed

1 file changed

+7
-0
lines changed

dsi/dsi.py

Lines changed: 7 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -821,6 +821,13 @@ def summary(self, table_name = None, collection = False):
821821
If specified, only the numerical metadata for that table will be printed.
822822
823823
If None (default), metadata for all available tables is printed.
824+
825+
`collection` : bool, optional, default False.
826+
If True, and table_name specified, returns a Pandas DataFrame of the summary of that table.
827+
828+
If True, and table_name not specified, returns a list of Pandas DataFrames of the summary of all tables.
829+
830+
If False (default), prints each table's name and dimensions to the console.
824831
"""
825832
if not self.t.valid_backend(self.main_backend_obj, self.main_backend_obj.__class__.__bases__[0].__name__):
826833
sys.exit("ERROR: Cannot call summary() on an empty backend. Please ensure there is data in it.")

0 commit comments

Comments
 (0)