From 92a1af35b8de4afb6cdb5b5e89facdceb5c151d2 Mon Sep 17 00:00:00 2001 From: Garrett Wu <6505921+GarrettWu@users.noreply.github.com> Date: Mon, 25 Mar 2024 12:10:17 -0700 Subject: [PATCH] docs: add progress_bar code sample (#508) MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit 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](https://togithub.com/googleapis/python-bigquery-dataframes/issues/new/choose) 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) Fixes # 🦕 --- .../bigframes_vendored/pandas/core/config_init.py | 14 +++++++++++++- 1 file changed, 13 insertions(+), 1 deletion(-) diff --git a/third_party/bigframes_vendored/pandas/core/config_init.py b/third_party/bigframes_vendored/pandas/core/config_init.py index 33c6b3e093..ecc103d7c8 100644 --- a/third_party/bigframes_vendored/pandas/core/config_init.py +++ b/third_party/bigframes_vendored/pandas/core/config_init.py @@ -32,9 +32,21 @@ User can execute the job by calling .to_pandas() >>> # df.to_pandas() -Reset option +Reset repr_mode option >>> bpd.options.display.repr_mode = "head" +Can also set the progress_bar option to see the progress bar in terminal, + >>> bpd.options.display.progress_bar = "terminal" + +notebook, + >>> bpd.options.display.progress_bar = "notebook" + +or just remove it. + >>> bpd.options.display.progress_bar = None + +Setting to default value "auto" will detect and show progress bar automatically. + >>> bpd.options.display.progress_bar = "auto" + Attributes: max_columns (int, default 20): If `max_columns` is exceeded, switch to truncate view.