@@ -73,7 +73,12 @@ def _init_bigquery_thread_local(self):
73
73
74
74
@property
75
75
def bigquery (self ) -> bigquery_options .BigQueryOptions :
76
- """Options to use with the BigQuery engine."""
76
+ """Options to use with the BigQuery engine.
77
+
78
+ Returns:
79
+ bigframes._config.bigquery_options.BigQueryOptions:
80
+ Options for BigQuery engine.
81
+ """
77
82
if self ._local .bigquery_options is not None :
78
83
# The only way we can get here is if someone called
79
84
# _init_bigquery_thread_local.
@@ -83,7 +88,12 @@ def bigquery(self) -> bigquery_options.BigQueryOptions:
83
88
84
89
@property
85
90
def display (self ) -> display_options .DisplayOptions :
86
- """Options controlling object representation."""
91
+ """Options controlling object representation.
92
+
93
+ Returns:
94
+ bigframes._config.display_options.DisplayOptions:
95
+ Options for controlling object representation.
96
+ """
87
97
return self ._local .display_options
88
98
89
99
@property
@@ -95,12 +105,21 @@ def sampling(self) -> sampling_options.SamplingOptions:
95
105
(e.g., to_pandas, to_numpy, values) or implicitly (e.g.,
96
106
matplotlib plotting). This option can be overriden by
97
107
parameters in specific functions.
108
+
109
+ Returns:
110
+ bigframes._config.sampling_options.SamplingOptions:
111
+ Options for controlling downsampling.
98
112
"""
99
113
return self ._local .sampling_options
100
114
101
115
@property
102
116
def compute (self ) -> compute_options .ComputeOptions :
103
- """Thread-local options controlling object computation."""
117
+ """Thread-local options controlling object computation.
118
+
119
+ Returns:
120
+ bigframes._config.compute_options.ComputeOptions:
121
+ Thread-local options for controlling object computation
122
+ """
104
123
return self ._local .compute_options
105
124
106
125
@property
@@ -109,6 +128,11 @@ def is_bigquery_thread_local(self) -> bool:
109
128
110
129
A thread-local session can be started by using
111
130
`with bigframes.option_context("bigquery.some_option", "some-value"):`.
131
+
132
+ Returns:
133
+ bool:
134
+ A boolean value, where a value is True if a thread-local session
135
+ is in use; otherwise False.
112
136
"""
113
137
return self ._local .bigquery_options is not None
114
138
0 commit comments