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

Minor doc fix for Series.to_string

Browse Source
This commit is contained in:
Stephen Dodson 2019-11-22 16:29:51 +00:00
parent 91c811345c
commit e755a2e160
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/series.py
View File

@ -23,7 +23,7 @@ import pandas as pd
from pandas.io.common import _expand_user, _stringify_path from pandas.io.common import _expand_user, _stringify_path
from eland import NDFrame from eland import NDFrame
from eland.common import DEFAULT_NUM_ROWS_DISPLAYED from eland.common import DEFAULT_NUM_ROWS_DISPLAYED, docstring_parameter
from eland.filter import NotFilter, Equal, Greater, Less, GreaterEqual, LessEqual, ScriptFilter, IsIn from eland.filter import NotFilter, Equal, Greater, Less, GreaterEqual, LessEqual, ScriptFilter, IsIn
@ -269,6 +269,7 @@ class Series(NDFrame):
return result return result
@docstring_parameter(DEFAULT_NUM_ROWS_DISPLAYED)
def to_string( def to_string(
self, self,
buf=None, buf=None,
@ -282,6 +283,17 @@ class Series(NDFrame):
max_rows=None, max_rows=None,
min_rows=None, min_rows=None,
): ):
"""
Render a string representation of the Series.
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
--------
:pandas_api_docs:`pandas.Series.to_string`
for argument details.
"""
# In pandas calling 'to_string' without max_rows set, will dump ALL rows - we avoid this # In pandas calling 'to_string' without max_rows set, will dump ALL rows - we avoid this
# by limiting rows by default. # by limiting rows by default.
num_rows = len(self) # avoid multiple calls num_rows = len(self) # avoid multiple calls