Skip to content

docs: fix docstrings to improve html rendering of code examples #1788

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
shobsi merged 2 commits into from
Jun 2, 2025
Merged

docs: fix docstrings to improve html rendering of code examples #1788

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
387f70f
docs: fix docstrings to improve html rendering of code examples
shobsi Jun 2, 2025
1ef1922
fix examples docstring in one more file
shobsi Jun 2, 2025
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
1 change: 1 addition & 0 deletions third_party/bigframes_vendored/pandas/core/computation/eval.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -171,6 +171,7 @@ def eval(
with plain ol' Python evaluation.

**Examples:**

>>> import bigframes.pandas as bpd
>>> bpd.options.display.progress_bar = None

Expand Down
1 change: 1 addition & 0 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 @@ -4253,6 +4253,7 @@ def corrwith(
correlations.

**Examples:**

>>> import bigframes.pandas as bpd
>>> bpd.options.display.progress_bar = None

Expand Down
1 change: 1 addition & 0 deletions third_party/bigframes_vendored/pandas/core/indexes/accessor.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -204,6 +204,7 @@ def isocalendar(self):
Calculate year, week, and day according to the ISO 8601 standard.

**Examples:**

>>> import pandas as pd
>>> import bigframes.pandas as bpd
>>> bpd.options.display.progress_bar = None
Expand Down
1 change: 1 addition & 0 deletions third_party/bigframes_vendored/pandas/io/gbq.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -67,6 +67,7 @@ def read_gbq(
>>> df = bpd.read_gbq("bigquery-public-data.ml_datasets.penguins")

Read table path with wildcard suffix and filters:

>>> df = bpd.read_gbq_table("bigquery-public-data.noaa_gsod.gsod19*", filters=[("_table_suffix", ">=", "30"), ("_table_suffix", "<=", "39")])

Preserve ordering in a query input.
Expand Down