From 7cbc69a4ca51a1ce159a3ee1c1a8f74a234c727e Mon Sep 17 00:00:00 2001 From: Philip Eisenlohr Date: Mon, 8 Mar 2021 11:02:27 -0500 Subject: [PATCH] added "Returns" to help --- python/damask/_table.py | 39 +++++++++++++++++++++++++++++++++++++++ 1 file changed, 39 insertions(+) diff --git a/python/damask/_table.py b/python/damask/_table.py index 68d6f94bf..5203b0b61 100644 --- a/python/damask/_table.py +++ b/python/damask/_table.py @@ -189,6 +189,11 @@ class Table: label : str Column label. + Returns + ------- + data : numpy.ndarray + Array of column data. + """ if re.match(r'[0-9]*?_',label): idx,key = label.split('_',1) @@ -212,6 +217,11 @@ class Table: info : str, optional Human-readable information about the new data. + Returns + ------- + table : Table + Updated table. + """ dup = self.copy() dup._add_comment(label,data.shape[1:],info) @@ -238,6 +248,11 @@ class Table: info : str, optional Human-readable information about the modified data. + Returns + ------- + table : Table + Updated table. + """ dup = self.copy() dup._add_comment(label,data.shape[1:],info) @@ -261,6 +276,11 @@ class Table: label : str Column label. + Returns + ------- + table : Table + Updated table. + """ dup = self.copy() dup.data.drop(columns=label,inplace=True) @@ -279,6 +299,11 @@ class Table: label_new : str or iterable of str New column label(s). + Returns + ------- + table : Table + Updated table. + """ dup = self.copy() columns = dict(zip([old] if isinstance(old,str) else old, @@ -300,6 +325,11 @@ class Table: ascending : bool or list, optional Set sort order. + Returns + ------- + table : Table + Updated table. + """ dup = self.copy() dup._label_discrete() @@ -320,6 +350,11 @@ class Table: other : Table Table to append. + Returns + ------- + table : Table + Concatenated table. + """ if self.shapes != other.shapes or not self.data.columns.equals(other.data.columns): raise KeyError('Labels or shapes or order do not match') @@ -340,6 +375,10 @@ class Table: other : Table Table to join. + Returns + ------- + table : Table + Joined table. """ if set(self.shapes) & set(other.shapes) or self.data.shape[0] != other.data.shape[0]: raise KeyError('Dublicated keys or row count mismatch')