More documentation.

[pyutils.git] / src / pyutils / remote_worker.py

diff --git a/src/pyutils/remote_worker.py b/src/pyutils/remote_worker.py
index 54f562da181d8d21b9891c8b99cfcc8e2dcd43fe..630d7e035fd414b166a1dda358ffd6aa430a70cd 100755 (executable)
--- a/src/pyutils/remote_worker.py
+++ b/src/pyutils/remote_worker.py
@@ -4,6 +4,11 @@
 
 """A simple utility to unpickle some code, run it, and pickle the
 results.  Please don't unpickle (or run!) code you do not know.
+
+This script is used by code in parallelize, namely the
+:class:`RemoteExecutor`, to schedule work on a remote machine.
+The code in :file:`parallelize.py` uses a user-defined configuration
+to schedule work this way.  See that file for setup instructions.
 """
 
 import logging