Skip to content

Commit 11af815

Browse files
committed
refactor: improve is_cancelled docs
Use the more general "interrupted" to be more precise. JIRA: CQ-1411 risk: low
1 parent f7f40bb commit 11af815

File tree

4 files changed

+11
-11
lines changed

4 files changed

+11
-11
lines changed

gooddata-pandas/gooddata_pandas/data_access.py

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -43,7 +43,7 @@ def __init__(self, columns: ColumnsDef, index_by: Optional[IndexDef] = None, is_
4343
columns (ColumnsDef): Input columns to process and build internal mappings.
4444
index_by (Optional[IndexDef], optional): Index definition to process. Defaults to None.
4545
is_cancellable (Optional[bool]): Whether the execution of this definition should be cancelled when
46-
the connection is cancelled.
46+
the connection is interrupted.
4747
4848
"""
4949
self._attributes: list[Attribute] = []
@@ -274,7 +274,7 @@ def _compute(
274274
index_by (Optional[IndexDef]): The index definition, if any.
275275
filter_by (Optional[Union[Filter, list[Filter]]]): A filter or a list of filters, if any.
276276
is_cancellable (bool, optional): Whether the execution of this definition should be cancelled when
277-
the connection is cancelled.
277+
the connection is interrupted.
278278
279279
Returns:
280280
tuple: A tuple containing the following elements:
@@ -434,7 +434,7 @@ def compute_and_extract(
434434
on_execution_submitted (Optional[Callable[[Execution], None]]): Callback to call when the execution was
435435
submitted to the backend.
436436
is_cancellable (bool, optional): Whether the execution of this definition should be cancelled when
437-
the connection is cancelled.
437+
the connection is interrupted.
438438
439439
Returns:
440440
tuple: A tuple containing the following dictionaries:

gooddata-pandas/gooddata_pandas/dataframe.py

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -89,7 +89,7 @@ def indexed(
8989
Optional filters to apply during computation on the server.
9090
on_execution_submitted (Optional[Callable[[Execution], None]]): Callback to call when the execution was
9191
submitted to the backend.
92-
is_cancellable (bool, optional): Whether the execution should be cancelled when the connection is cancelled.
92+
is_cancellable (bool, optional): Whether the execution should be cancelled when the connection is interrupted.
9393
9494
Returns:
9595
pandas.DataFrame: A DataFrame instance.
@@ -124,7 +124,7 @@ def not_indexed(
124124
computation on the server.
125125
on_execution_submitted (Optional[Callable[[Execution], None]]): Callback to call when the execution was
126126
submitted to the backend.
127-
is_cancellable (bool, optional): Whether the execution should be cancelled when the connection is cancelled.
127+
is_cancellable (bool, optional): Whether the execution should be cancelled when the connection is interrupted.
128128
129129
Returns:
130130
pandas.DataFrame: A DataFrame instance.
@@ -161,7 +161,7 @@ def for_items(
161161
of the items.
162162
on_execution_submitted (Optional[Callable[[Execution], None]]): Callback to call when the execution was
163163
submitted to the backend.
164-
is_cancellable (bool, optional): Whether the execution should be cancelled when the connection is cancelled.
164+
is_cancellable (bool, optional): Whether the execution should be cancelled when the connection is interrupted.
165165
166166
Returns:
167167
pandas.DataFrame: A DataFrame instance.
@@ -210,7 +210,7 @@ def for_visualization(
210210
of the visualization.
211211
on_execution_submitted (Optional[Callable[[Execution], None]]): Callback to call when the execution was
212212
submitted to the backend.
213-
is_cancellable (bool, optional): Whether the execution should be cancelled when the connection is cancelled.
213+
is_cancellable (bool, optional): Whether the execution should be cancelled when the connection is interrupted.
214214
215215
Returns:
216216
pandas.DataFrame: A DataFrame instance.
@@ -246,7 +246,7 @@ def for_created_visualization(
246246
created_visualizations_response (dict): Created visualization response.
247247
on_execution_submitted (Optional[Callable[[Execution], None]]): Callback to call when the execution was
248248
submitted to the backend.
249-
is_cancellable (bool, optional): Whether the execution should be cancelled when the connection is cancelled.
249+
is_cancellable (bool, optional): Whether the execution should be cancelled when the connection is interrupted.
250250
251251
Returns:
252252
pandas.DataFrame: A DataFrame instance.

gooddata-pandas/gooddata_pandas/series.py

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -66,7 +66,7 @@ def indexed(
6666
on_execution_submitted (Optional[Callable[[Execution], None]]): Callback to call when the execution was
6767
submitted to the backend.
6868
69-
is_cancellable (bool, optional): Whether the execution should be cancelled when the connection is cancelled.
69+
is_cancellable (bool, optional): Whether the execution should be cancelled when the connection is interrupted.
7070
7171
Returns:
7272
pandas.Series: pandas series instance
@@ -121,7 +121,7 @@ def not_indexed(
121121
Defaults to None.
122122
on_execution_submitted (Optional[Callable[[Execution], None]]): Callback to call when the execution was
123123
submitted to the backend.
124-
is_cancellable (bool, optional): Whether the execution should be cancelled when the connection is cancelled.
124+
is_cancellable (bool, optional): Whether the execution should be cancelled when the connection is interrupted.
125125
126126
Returns:
127127
pandas.Series: The resulting pandas Series instance.

gooddata-sdk/gooddata_sdk/compute/service.py

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -98,7 +98,7 @@ def build_exec_def_from_chat_result(
9898
Args:
9999
chat_result: ChatResult object containing visualization details from AI chat response
100100
is_cancellable (bool, optional): Whether the execution of this definition should be cancelled when
101-
the connection is cancelled.
101+
the connection is interrupted.
102102
103103
Returns:
104104
ExecutionDefinition: Execution definition built from chat result visualization

0 commit comments

Comments
 (0)