Skip to content

Commit 42d240e

Browse files
committed
moved TODOs from docstring to above signature of Larray.i() and LArray.ipoints() because it breaks generated documentation.
1 parent 3e5462e commit 42d240e

File tree

1 file changed

+4
-4
lines changed

1 file changed

+4
-4
lines changed

larray/core/array.py

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -895,6 +895,7 @@ def __dir__(self):
895895
def _ipython_key_completions_(self):
896896
return list(chain(*[list(labels) for labels in self.axes.labels]))
897897

898+
# TODO: the first slice in example below should be documented
898899
@lazy_attribute
899900
def i(self):
900901
"""
@@ -912,7 +913,6 @@ def i(self):
912913
a1 b1 16 17 18 19
913914
a1 b2 20 21 22 23
914915
915-
# TODO: the first slice here should be documented
916916
>>> arr.i[:, 0:2, [0, 2]]
917917
a b\\c c0 c2
918918
a0 b0 0 2
@@ -956,6 +956,9 @@ def points(self):
956956
"""
957957
return LArrayPointsIndexer(self)
958958

959+
# TODO: show that we need to use a "full slice" for leaving the dimension alone
960+
# TODO: document explicitly that axes should be in the correct order and missing axes should be slice None
961+
# (except at the end)
959962
@lazy_attribute
960963
def ipoints(self):
961964
"""
@@ -976,9 +979,6 @@ def ipoints(self):
976979
To select the two points with index coordinates
977980
[0, 0, 0] and [1, 2, 2], you must do:
978981
979-
# TODO: show that we need to use a "full slice" for leaving the dimension alone
980-
# TODO: document explicitly that axes should be in the correct order and missing axes should be slice None
981-
# (except at the end)
982982
>>> arr.ipoints[[0,1], [0,2], [0,2]]
983983
a_b_c a0_b0_c0 a1_b2_c2
984984
0 22

0 commit comments

Comments
 (0)