Skip to content

Commit 5f73eae

Browse files
committed
>> (820) : removed _axes_display_names private argument from docstring of Array.dump()
1 parent dcc8568 commit 5f73eae

File tree

1 file changed

+7
-4
lines changed

1 file changed

+7
-4
lines changed

larray/core/array.py

Lines changed: 7 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -2443,7 +2443,9 @@ def as_table(self, maxlines=-1, edgeitems=5, light=False, wide=True, value_name=
24432443
# XXX: dump as a 2D Array with row & col dims?
24442444
def dump(self, header=True, wide=True, value_name='value', light=False, axes_names=True, na_repr='as_is',
24452445
maxlines=-1, edgeitems=5, _axes_display_names=False):
2446-
r"""
2446+
r"""dump(self, header=True, wide=True, value_name='value', light=False, axes_names=True, na_repr='as_is',
2447+
maxlines=-1, edgeitems=5)
2448+
24472449
Dump array as a 2D nested list. This is especially useful when writing to an Excel sheet via open_excel().
24482450
24492451
Parameters
@@ -2470,9 +2472,6 @@ def dump(self, header=True, wide=True, value_name='value', light=False, axes_nam
24702472
edgeitems : int, optional
24712473
If number of lines to display is greater than `maxlines`, only the first and last `edgeitems` lines are
24722474
displayed. Only active if `maxlines` is not -1. Defaults to 5.
2473-
_axes_display_names : bool, optional
2474-
Whether or not to get axes names using :py:obj:`~AxisCollection.display_names` instead of
2475-
:py:obj:`~AxisCollection.names`. Defaults to False.
24762475
24772476
Returns
24782477
-------
@@ -2521,6 +2520,10 @@ def dump(self, header=True, wide=True, value_name='value', light=False, axes_nam
25212520
['...', '...', '...', '...'],
25222521
['a1', 'b1', 6, 7]]
25232522
"""
2523+
# _axes_display_names : bool, optional
2524+
# Whether or not to get axes names using AxisCollection.display_names instead of
2525+
# AxisCollection.names. Defaults to False.
2526+
25242527
dump_axes_names = axes_names
25252528

25262529
if not header:

0 commit comments

Comments
 (0)