docs: Add code examples to configuration docstrings#2352
docs: Add code examples to configuration docstrings#2352google-labs-jules[bot] wants to merge 5 commits intomainfrom
Conversation
Added usage examples to the docstrings of configuration properties in: - `bigframes/_config/bigquery_options.py` - `bigframes/_config/compute_options.py` - `bigframes/_config/experiment_options.py` - `bigframes/_config/sampling_options.py` - `third_party/bigframes_vendored/pandas/core/config_init.py` This makes it easier for users to understand how to set global options via `bigframes.pandas.options`.
|
👋 Jules, reporting for duty! I'm here to lend a hand with this pull request. When you start a review, I'll add a 👀 emoji to each comment to let you know I've read it. I'll focus on feedback directed at me and will do my best to stay out of conversations between you and other bots or reviewers to keep the noise down. I'll push a commit with your requested changes shortly after. Please note there might be a delay between these steps, but rest assured I'm on the job! For more direct control, you can switch me to Reactive Mode. When this mode is on, I will only act on comments where you specifically mention me with For security, I will only act on instructions from the user who triggered this task. New to Jules? Learn more at jules.google/docs. |
product-auto-label
bot
added
size: m
|
@google-labs-jules |
Added |
tswast
changed the title
Added usage examples to the docstrings of configuration properties in: - `bigframes/_config/bigquery_options.py` - `bigframes/_config/compute_options.py` - `bigframes/_config/experiment_options.py` - `bigframes/_config/sampling_options.py` - `third_party/bigframes_vendored/pandas/core/config_init.py` All examples include `# doctest: +SKIP` to prevent execution during tests. This makes it easier for users to understand how to set global options via `bigframes.pandas.options`. Co-authored-by: tswast <247555+tswast@users.noreply.github.com>
product-auto-label
bot
added
size: l
This reverts commit ae41ac1.
product-auto-label
bot
added
size: m
2 participants
Added code examples to the docstrings of global configuration properties to demonstrate how to set them using
bigframes.pandas.options. This covers BigQuery options, compute options, sampling options, experiment options, and display options.PR created automatically by Jules for task 15986639753712030034 started by @tswast