Skip to content

Commit 557ab8d

Browse files
authored
docs: update bigframes.pandas.Index docstrings (#1144)
* docs: update `bigframes.pandas.Index` docstrings * updating more methods * update docstrings of more methods * update docstrings * update docs * update docstrings * fix failing doc test * fix docs indentation * fix indentation error * fix doctest error * fix doctest error * fix errors * fix errors * fix failing doctest * remove .name docstring
1 parent daef4f0 commit 557ab8d

File tree

2 files changed

+531
-38
lines changed
  • bigframes/core/indexes
  • third_party/bigframes_vendored/pandas/core/indexes

2 files changed

+531
-38
lines changed

bigframes/core/indexes/base.py

-8
Original file line numberDiff line numberDiff line change
@@ -134,7 +134,6 @@ def name(self, value: blocks.Label):
134134

135135
@property
136136
def names(self) -> typing.Sequence[blocks.Label]:
137-
"""Returns the names of the Index."""
138137
return self._block._index_labels
139138

140139
@names.setter
@@ -175,7 +174,6 @@ def dtypes(self) -> pandas.Series:
175174

176175
@property
177176
def size(self) -> int:
178-
"""Returns the size of the Index."""
179177
return self.shape[0]
180178

181179
@property
@@ -186,12 +184,6 @@ def empty(self) -> bool:
186184
@property
187185
@validations.requires_ordering()
188186
def is_monotonic_increasing(self) -> bool:
189-
"""
190-
Return a boolean if the values are equal or increasing.
191-
192-
Returns:
193-
bool
194-
"""
195187
return typing.cast(
196188
bool,
197189
self._block.is_monotonic_increasing(self._block.index_columns),

0 commit comments

Comments
 (0)