Skip to content

Commit b902865

Browse files
committed
doc checker
1 parent 48be1ec commit b902865

File tree

3 files changed

+17
-2
lines changed

3 files changed

+17
-2
lines changed

modin/config/envvars.py

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -521,6 +521,11 @@ def activate(cls, backend: str) -> None:
521521
522522
This is a no-op if the backend is already active.
523523
524+
Parameters
525+
----------
526+
backend : str
527+
Backend to activate.
528+
524529
Raises
525530
------
526531
ValueError

modin/core/storage_formats/base/query_compiler_calculator.py

Lines changed: 12 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -33,6 +33,14 @@
3333

3434

3535
def all_switchable_backends() -> list[str]:
36+
"""
37+
Return a list of all currently active backends that are candidates for switching.
38+
39+
Returns
40+
-------
41+
list
42+
A list of valid backends.
43+
"""
3644
return list(
3745
filter(
3846
# Disable automatically switching to these engines for now, because
@@ -54,7 +62,8 @@ class AggregatedBackendData:
5462
----------
5563
backend : str
5664
String representing the backend name.
57-
query_compiler : QueryCompiler
65+
qc_cls : type[QueryCompiler]
66+
The query compiler sub-class for this backend.
5867
"""
5968

6069
def __init__(self, backend: str, qc_cls: type[BaseQueryCompiler]):
@@ -81,6 +90,8 @@ class BackendCostCalculator:
8190
Representing the class name of the function being called.
8291
operation : str representing the operation being performed
8392
query_compilers : list of query compiler arguments
93+
preop_switch : bool
94+
True if the operation is a pre-operation switch point.
8495
"""
8596

8697
def __init__(

modin/tests/pandas/native_df_interoperability/test_compiler_caster.py

Lines changed: 0 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1848,7 +1848,6 @@ class AQC(NativeQueryCompiler):
18481848
assert qc._transfer_threshold() == oldthresh
18491849

18501850

1851-
@backend_test_context(choices=("Pico", "Cluster"))
18521851
def test_cast_metrics(pico_df, cluster_df):
18531852
try:
18541853
count = 0

0 commit comments

Comments
 (0)