Update documentation for register_worker_plugin (#5533)

dask · Nov 22, 2021 · b3415d2 · b3415d2
1 parent f7cb529
commit b3415d2
Show file tree

Hide file tree

Showing 2 changed files with 2 additions and 2 deletions.
diff --git a/distributed/client.py b/distributed/client.py
@@ -4273,7 +4273,7 @@ def register_worker_plugin(self, plugin=None, name=None, nanny=None, **kwargs):
 
         If the plugin has a ``name`` attribute, or if the ``name=`` keyword is
         used then that will control idempotency.  If a plugin with that name has
-        already been registered then any future plugins will not run.
+        already been registered, then it will be removed and replaced by the new one.
 
         For alternatives to plugins, you may also wish to look into preload
         scripts.

diff --git a/distributed/scheduler.py b/distributed/scheduler.py
@@ -7206,7 +7206,7 @@ def stop_task_metadata(self, comm=None, name=None):
         return {"metadata": plugin.metadata, "state": plugin.state}
 
     async def register_worker_plugin(self, comm, plugin, name=None):
-        """Registers a setup function, and call it on every worker"""
+        """Registers a worker plugin on all running and future workers"""
         self.worker_plugins[name] = plugin
 
         responses = await self.broadcast(