Skip to content

docs: update DataFrame docstrings to include the errors section #1127

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

Jump to bottom
Merged
merged 8 commits into from
Nov 6, 2024
Merged

docs: update DataFrame docstrings to include the errors section #1127

merged 8 commits into from
Nov 6, 2024

Conversation

arwas11
Copy link
Contributor

@arwas11 arwas11 commented Oct 31, 2024 •
edited
Loading

Thank you for opening a Pull Request! Before submitting your PR, there are a few things you can do to make sure it goes smoothly:

  • Make sure to open an issue as a bug/issue before writing your code! That way we can discuss the change, evaluate designs, and agree on the general idea
  • Ensure the tests and linter pass
  • Code coverage does not decrease (if any source code was changed)
  • Appropriate docs were updated (if necessary):
    • to_gbq: screen/6fahEb9CJ7r69yc
    • to_parquet: screen/3kBwqd5AHRTpP5W
    • insert: screen/QXBv9pWR8M9Toxo
    • drop: screen/9Si5uK9NhFjudc2
    • set_index: screen/aYEyVMgfeNH9nyk
    • reorder_levels: screen/4xRALnZrpUTMrSN
    • swaplevel: screen/7j9Zu4JJyzfnXMp
    • droplevel: screen/C5myDpnkGqLCCYe
    • dropna: screen/49hfZbyTjZqixVe
    • isin: screen/6fTGLaFYBe2NHGM
    • sort_values: screen/6FKiveqddSpZ8dz
    • sort_index: screen/3oHDsq5EHngLJgB
    • combine: screen/3vJBqsWf7TKe7dt
    • explode: screen/3oHDsq5EHngLJgB
    • update: screen/5dgpp9iqZpoLTXE
    • groupby: screen/8tSm9QYnQvLiixU
    • map: screen/BmfrwCH79QDeDsX
    • join: screen/FqZvzHrnGN9KvqX
    • merge: screen/57k9UzYy2MZ6oMr
    • apply: screen/4S3csoNQ9cHnxF5
    • nlargest: screen/BxvVoyrVm524yCu
    • nsmallest: screen/6hu4XG9ZknqNdcQ
    • cumsum: screen/7WT2AwmpCYyn2E9
    • cumprod: screen/6pjvBi3PY9wXS7e
    • describe: screen/5SU9DPxx338oUwh
    • dot: screen/Bt88eX4xUeQNLvC
    • sample: screen/9fYVqia2grZpeye
    • filter: screen/5oGofrU87PayQJu

Fixes #296390934 🦕

@product-auto-label product-auto-label bot added size: m Pull request size is medium. api: bigquery Issues related to the googleapis/python-bigquery-dataframes API. labels Oct 31, 2024
@tswast tswast marked this pull request as ready for review October 31, 2024 20:51
@tswast tswast requested review from a team as code owners October 31, 2024 20:51
@tswast tswast requested a review from shobsi October 31, 2024 20:51
tswast
tswast approved these changes Oct 31, 2024
View reviewed changes
Copy link
Collaborator

@tswast tswast left a comment

Choose a reason for hiding this comment

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

Thank you!

@tswast tswast enabled auto-merge (squash) October 31, 2024 20:54
@shobsi
Copy link
Contributor

shobsi commented Nov 5, 2024

Are there screenshots of the documentation (the "Appropriate docs were updated" section in the description) after this change? E.g. #1081

@arwas11
Copy link
Contributor Author

arwas11 commented Nov 5, 2024

Are there screenshots of the documentation (the "Appropriate docs were updated" section in the description) after this change? E.g. #1081

@shobsi Thanks for pointing that out! I added the screenshots.

@arwas11 arwas11 requested a review from tswast November 6, 2024 21:43
shobsi
shobsi reviewed Nov 6, 2024
View reviewed changes
third_party/bigframes_vendored/pandas/core/frame.py
ValueError:
If an invalid value is provided for ``if_exists`` when ``destination_table``
is ``None``. ``None`` or ``replace`` are the only valid values for ``if_exists``.
ValueError:
Copy link
Contributor

Choose a reason for hiding this comment

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

Thanks for sharing the screenshots. I think we should have one row per exception, It looks repetitive/redundant in the generated docs screen/6fahEb9CJ7r69yc

@tswast tswast merged commit a38d4c4 into main Nov 6, 2024
21 of 23 checks passed
@tswast tswast deleted the b296390934-docstrings-type-annotation-raises branch November 6, 2024 22:38
@release-please release-please bot mentioned this pull request Nov 6, 2024
Merged
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

@shobsi shobsi shobsi left review comments

@tswast tswast Awaiting requested review from tswast

Assignees

@TrevorBergeron TrevorBergeron

Labels

api: bigquery Issues related to the googleapis/python-bigquery-dataframes API. size: m Pull request size is medium.

Projects

None yet

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

4 participants

@arwas11 @shobsi @tswast @TrevorBergeron