Skip to content
This repository was archived by the owner on Apr 1, 2026. It is now read-only.

docs: update bigframes.pandas.Index docstrings #1144

Merged
tswast merged 21 commits into from
Nov 27, 2024
Merged

docs: update bigframes.pandas.Index docstrings #1144

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
21 commits
Select commit Hold shift + click to select a range
1871ed2
docs: update `bigframes.pandas.Index` docstrings
arwas11 Nov 6, 2024
8bcb37c
updating more methods
arwas11 Nov 13, 2024
587d479
update docstrings of more methods
arwas11 Nov 14, 2024
2939c30
Merge remote-tracking branch 'origin/main' into b296390934-docstrings…
arwas11 Nov 14, 2024
31dc08e
Merge remote-tracking branch 'origin/main' into b296390934-docstrings…
arwas11 Nov 15, 2024
b6bb657
update docstrings
arwas11 Nov 15, 2024
a0a3468
Merge remote-tracking branch 'origin/main' into b296390934-docstrings…
arwas11 Nov 20, 2024
a35f2b8
update docs
arwas11 Nov 20, 2024
0f24b5c
update docstrings
arwas11 Nov 21, 2024
6cfa920
fix failing doc test
arwas11 Nov 21, 2024
7e70ceb
fix docs indentation
arwas11 Nov 21, 2024
6dd9c4f
Merge remote-tracking branch 'origin/main' into b296390934-docstrings…
arwas11 Nov 22, 2024
b796b2b
fix indentation error
arwas11 Nov 22, 2024
f6b00a7
fix doctest error
arwas11 Nov 22, 2024
aaf224e
fix doctest error
arwas11 Nov 25, 2024
78c4d0b
fix errors
arwas11 Nov 25, 2024
9dca929
fix errors
arwas11 Nov 25, 2024
1846587
Merge remote-tracking branch 'origin/main' into b296390934-docstrings…
arwas11 Nov 26, 2024
d5e39f4
fix failing doctest
arwas11 Nov 26, 2024
fd90334
remove .name docstring
arwas11 Nov 27, 2024
bb74763
Merge remote-tracking branch 'origin/main' into b296390934-docstrings…
arwas11 Nov 27, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
8 changes: 0 additions & 8 deletions bigframes/core/indexes/base.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -134,7 +134,6 @@ def name(self, value: blocks.Label):

@property
def names(self) -> typing.Sequence[blocks.Label]:
"""Returns the names of the Index."""
Copy link
Copy Markdown
Contributor

@tswast tswast Nov 22, 2024

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

For context for Huan, these are borrowed from pandas, so need to come from third_party.

return self._block._index_labels

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

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

@property
Expand All @@ -186,12 +184,6 @@ def empty(self) -> bool:
@property
@validations.requires_ordering()
def is_monotonic_increasing(self) -> bool:
"""
Return a boolean if the values are equal or increasing.

Returns:
bool
"""
return typing.cast(
bool,
self._block.is_monotonic_increasing(self._block.index_columns),
Expand Down
Loading