Clarify name parameter docstring

dask · Sep 27, 2023 · 5c2ceb9 · 5c2ceb9
1 parent 30234e3
commit 5c2ceb9
Showing 1 changed file with 4 additions and 2 deletions.
diff --git a/dask_kubernetes/operator/kubecluster/kubecluster.py b/dask_kubernetes/operator/kubecluster/kubecluster.py
@@ -60,8 +60,10 @@ class KubeCluster(Cluster):
 
     Parameters
     ----------
-    name: str (required)
-        Name given the Dask cluster.
+    name: str
+        Name given the Dask cluster. Required except when custom_cluster_spec is
+        passed, in which case it's ignored in favor of
+        custom_cluster_spec["metadata"]["name"].
     namespace: str (optional)
         Namespace in which to launch the workers.
         Defaults to current namespace if available or "default"