Skip to content
Snippets Groups Projects
Commit 0665773c authored by Bert Palm's avatar Bert Palm 🎇
Browse files

some docu fixes

parent 0a80f8fe
No related branches found
No related tags found
No related merge requests found
...@@ -416,9 +416,9 @@ class DictOfSeries(_DiosBase): ...@@ -416,9 +416,9 @@ class DictOfSeries(_DiosBase):
def index_of(self, method='all'): def index_of(self, method='all'):
""" Return an single index with indices from all columns. """ Return an single index with indices from all columns.
parameter Parameters
---------- ----------
method: string method : string
* 'all' : get all indices from all columns * 'all' : get all indices from all columns
* 'union' : alias for 'all' * 'union' : alias for 'all'
* 'shared' : get indices that are present in every columns * 'shared' : get indices that are present in every columns
...@@ -588,7 +588,7 @@ class DictOfSeries(_DiosBase): ...@@ -588,7 +588,7 @@ class DictOfSeries(_DiosBase):
return self.notna(drop_empty=True) return self.notna(drop_empty=True)
def isnull(self, drop_empty=False): def isnull(self, drop_empty=False):
""" Alias, see ``DictOfSeries.isna``. """ """ Alias, see :ref:`DictOfSeries.isna`. """
return self.isna(drop_empty=drop_empty) return self.isna(drop_empty=drop_empty)
def notnull(self, drop_empty=False): def notnull(self, drop_empty=False):
...@@ -614,32 +614,50 @@ class DictOfSeries(_DiosBase): ...@@ -614,32 +614,50 @@ class DictOfSeries(_DiosBase):
""" Pretty print a dios. """ Pretty print a dios.
if `method` == `indexed` (default): if `method` == `indexed` (default):
every column is represented by a own index and corresponding values every column is represented by a own index and corresponding values
if `method` == `aligned` [2]: if `method` == `aligned` [2]:
one(!) global index is generated and values from a column appear at one(!) global index is generated and values from a column appear at
the corresponding index-location. the corresponding index-location.
Common params : Parameters
- max_cols: not more column than `max_cols` are printed [1] ---------
- max_rows: see `min_rows` [1]
- min_rows: not more rows than `min_rows` are printed, if rows of any series exceed `max_rows` [1] max_cols :
- na_rep: all NaN-values are replaced by `na_rep`. Default `NaN` not more column than `max_cols` are printed [1]
Indexed-Method params: max_rows :
- empty_series_rep: empty series are represented by the string in `empty_series_rep` see `min_rows` [1]
- col_delim: between all columns `col_delim` is inserted. (str)
- header_delim: between the column names (header) and the data, `header_delim` is inserted, min_rows :
if not None. The string is repeated, up to the width of the column. (str or None). not more rows than `min_rows` are printed, if rows of any series exceed `max_rows` [1]
Aligned-Method params: na_rep :
- no_value: value that indicates, that no entry in the underling series is present. Bear in mind all NaN-values are replaced by `na_rep`. Default `NaN`
that this should differ from `na_rep`, otherwise you cannot differ missing- from NaN- values.
empty_series_rep :
Notes: Ignored if not `method='indexed'`.
[1]: defaults to the corresponding value in `dios_options` Empty series are represented by the string in `empty_series_rep`
[2]: the common-params are directly passed to pd.DataFrame.to_string(..)
under the hood, if method is `aligned` col_delim : str
Ignored if not `method='indexed'`.
between all columns `col_delim` is inserted.
header_delim :
Ignored if not `method='indexed'`.
between the column names (header) and the data, `header_delim` is inserted,
if not None. The string is repeated, up to the width of the column. (str or None).
no_value :
Ignored if not `method='aligned'`.
value that indicates, that no entry in the underling series is present. Bear in mind
that this should differ from `na_rep`, otherwise you cannot differ missing- from NaN- values.
Notes
-----
[1]: defaults to the corresponding value in `dios_options`
[2]: the common-params are directly passed to pd.DataFrame.to_string(..)
under the hood, if method is `aligned`
""" """
if self.empty: if self.empty:
......
0% Loading or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment