From d7d7da9919ac589a019e115ea238e67040c26da2 Mon Sep 17 00:00:00 2001 From: "K.-Michael Aye" Date: Mon, 6 May 2019 15:22:07 -0600 Subject: [PATCH] DOC: Clean up reference to cluster object The current docs would overwrite the cluster objects, so it needs to get its own variable name. As the Client is usually named `c`, I changed the cluster object to the name `cluster` --- distributed/deploy/local.py | 10 +++++----- 1 file changed, 5 insertions(+), 5 deletions(-) diff --git a/distributed/deploy/local.py b/distributed/deploy/local.py index ad8b36f6dd7..3431210a645 100644 --- a/distributed/deploy/local.py +++ b/distributed/deploy/local.py @@ -82,19 +82,19 @@ class LocalCluster(Cluster): Examples -------- - >>> c = LocalCluster() # Create a local cluster with as many workers as cores # doctest: +SKIP - >>> c # doctest: +SKIP + >>> cluster = LocalCluster() # Create a local cluster with as many workers as cores # doctest: +SKIP + >>> cluster # doctest: +SKIP LocalCluster("127.0.0.1:8786", workers=8, ncores=8) - >>> c = Client(c) # connect to local cluster # doctest: +SKIP + >>> c = Client(cluster) # connect to local cluster # doctest: +SKIP Add a new worker to the cluster - >>> w = c.start_worker(ncores=2) # doctest: +SKIP + >>> w = cluster.start_worker(ncores=2) # doctest: +SKIP Shut down the extra worker - >>> c.stop_worker(w) # doctest: +SKIP + >>> cluster.stop_worker(w) # doctest: +SKIP Pass extra keyword arguments to Bokeh