Skip to content

Commit 3eb6a17

Browse files
authored
docs: fix the DisplayOptions doc rendering (#893)
1 parent 0603e62 commit 3eb6a17

File tree

1 file changed

+8
-0
lines changed

1 file changed

+8
-0
lines changed

third_party/bigframes_vendored/pandas/core/config_init.py

+8
Original file line numberDiff line numberDiff line change
@@ -18,6 +18,7 @@
1818
**Examples:**
1919
2020
Define Repr mode to "deferred" will prevent job execution in repr.
21+
2122
>>> import bigframes.pandas as bpd
2223
>>> df = bpd.read_gbq("bigquery-public-data.ml_datasets.penguins")
2324
@@ -26,25 +27,32 @@
2627
Computation deferred. Computation will process 28.9 kB
2728
2829
Users can also get a dry run of the job by accessing the query_job property before they've run the job. This will return a dry run instance of the job they can inspect.
30+
2931
>>> df.query_job.total_bytes_processed
3032
28947
3133
3234
User can execute the job by calling .to_pandas()
35+
3336
>>> # df.to_pandas()
3437
3538
Reset repr_mode option
39+
3640
>>> bpd.options.display.repr_mode = "head"
3741
3842
Can also set the progress_bar option to see the progress bar in terminal,
43+
3944
>>> bpd.options.display.progress_bar = "terminal"
4045
4146
notebook,
47+
4248
>>> bpd.options.display.progress_bar = "notebook"
4349
4450
or just remove it.
51+
4552
>>> bpd.options.display.progress_bar = None
4653
4754
Setting to default value "auto" will detect and show progress bar automatically.
55+
4856
>>> bpd.options.display.progress_bar = "auto"
4957
5058
Attributes:

0 commit comments

Comments
 (0)