third_codes/eland
1
0
Fork 0
mirror of https://github.com/elastic/eland.git synced 2025-07-24 00:00:39 +08:00
Code Issues Packages Projects Releases Wiki Activity

Updated to_string/to_html docs

Browse Source
This commit is contained in:
Stephen Dodson 2019-11-18 15:27:43 +00:00
parent 327f43d912
commit fb2a1fae7b
1 changed files with 13 additions and 1 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

14
eland/dataframe.py
View File

@ -22,6 +22,12 @@ from eland.filter import BooleanFilter, ScriptFilter
# Default number of rows displayed (different to pandas where ALL could be displayed) # Default number of rows displayed (different to pandas where ALL could be displayed)
DEFAULT_NUM_ROWS_DISPLAYED = 60 DEFAULT_NUM_ROWS_DISPLAYED = 60
def docstring_parameter(*sub):
def dec(obj):
obj.__doc__ = obj.__doc__.format(*sub)
return obj
return dec
class DataFrame(NDFrame): class DataFrame(NDFrame):
""" """
@ -540,6 +546,7 @@ class DataFrame(NDFrame):
fmt.buffer_put_lines(buf, lines) fmt.buffer_put_lines(buf, lines)
@docstring_parameter(DEFAULT_NUM_ROWS_DISPLAYED)
def to_html(self, buf=None, columns=None, col_space=None, header=True, def to_html(self, buf=None, columns=None, col_space=None, header=True,
index=True, na_rep='NaN', formatters=None, float_format=None, index=True, na_rep='NaN', formatters=None, float_format=None,
sparsify=None, index_names=True, justify=None, max_rows=None, sparsify=None, index_names=True, justify=None, max_rows=None,
@ -549,6 +556,9 @@ class DataFrame(NDFrame):
""" """
Render a Elasticsearch data as an HTML table. Render a Elasticsearch data as an HTML table.
Follows pandas implementation except when ``max_rows=None``. In this scenario, we set ``max_rows={0}`` to avoid
accidentally dumping an entire index. This can be overridden by explicitly setting ``max_rows``.
See Also See Also
-------- --------
:pandas_api_docs:`to_html` for argument details. :pandas_api_docs:`to_html` for argument details.
@ -597,6 +607,7 @@ class DataFrame(NDFrame):
result = _buf.getvalue() result = _buf.getvalue()
return result return result
@docstring_parameter(DEFAULT_NUM_ROWS_DISPLAYED)
def to_string(self, buf=None, columns=None, col_space=None, header=True, def to_string(self, buf=None, columns=None, col_space=None, header=True,
index=True, na_rep='NaN', formatters=None, float_format=None, index=True, na_rep='NaN', formatters=None, float_format=None,
sparsify=None, index_names=True, justify=None, sparsify=None, index_names=True, justify=None,
@ -605,7 +616,8 @@ class DataFrame(NDFrame):
""" """
Render a DataFrame to a console-friendly tabular output. Render a DataFrame to a console-friendly tabular output.
Follows pandas implementation except we set max_rows default to avoid careless extraction of entire index. Follows pandas implementation except when ``max_rows=None``. In this scenario, we set ``max_rows={0}`` to avoid
accidentally dumping an entire index. This can be overridden by explicitly setting ``max_rows``.
See Also See Also
-------- --------