Skip to content

docs: improve API documentation #489

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 6 commits into from
Mar 22, 2024
Merged

docs: improve API documentation #489

Changes from 1 commit
Commits
Show all changes
6 commits
Select commit Hold shift + click to select a range
1dc9e17
docs: fix docstring imperfections
shobsi Mar 2, 2024
2313108
Merge remote-tracking branch 'refs/remotes/github/main' into shobs-do…
shobsi Mar 20, 2024
da5c506
fix docstring for `df.itertuples`
shobsi Mar 20, 2024
6d25fca
more docstring updates
shobsi Mar 21, 2024
9baba8a
Merge remote-tracking branch 'refs/remotes/github/main' into shobs-do…
shobsi Mar 21, 2024
adbcd3e
Merge branch 'main' into shobs-docs-improve
shobsi Mar 22, 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
Next Next commit
docs: fix docstring imperfections
  • Loading branch information
@shobsi
shobsi committed Mar 2, 2024
commit 1dc9e17ae6049b55a792b3c31ac85efa4f4fffb4
4 changes: 2 additions & 2 deletions third_party/bigframes_vendored/pandas/core/frame.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -1141,7 +1141,7 @@ def align(

Args:
other (DataFrame or Series):
join ({{'outer', 'inner', 'left', 'right'}}, default 'outer'):
join ({'outer', 'inner', 'left', 'right'}, default 'outer'):
Type of alignment to be performed.
left: use only keys from left frame, preserve key order.
right: use only keys from right frame, preserve key order.
Expand Down Expand Up @@ -3155,7 +3155,7 @@ def join(self, other, *, on: Optional[str] = None, how: str) -> DataFrame:
on:
Column in the caller to join on the index in other, otherwise
joins index-on-index. Like an Excel VLOOKUP operation.
how ({'left', 'right', 'outer', 'inner'}, default 'left'`):
how ({'left', 'right', 'outer', 'inner'}, default 'left'):
How to handle the operation of the two objects.
``left``: use calling frame's index (or column if on is specified)
``right``: use `other`'s index. ``outer``: form union of calling
Expand Down