Merge pull request #508 from minrk/doc-asyncresult

docs tweaks

Author: minrk

docs/source/api/ipyparallel.rst

@@ -12,34 +12,45 @@ Classes
 -------
 
 .. autoclass:: Cluster
+    :inherited-members:
 
 .. autoclass:: Client
+    :inherited-members:
 
 .. autoclass:: DirectView
+    :inherited-members:
 
 .. autoclass:: LoadBalancedView
+    :inherited-members:
 
 .. autoclass:: BroadcastView
+    :inherited-members:
+
+.. autoclass:: AsyncResult
+    :inherited-members:
 
 .. autoclass:: ViewExecutor
+    :inherited-members:
 
 Decorators
 ----------
 
 IPython parallel provides some decorators to assist in using your functions as tasks.
 
-.. autofunction:: interactive
-.. autofunction:: require
-.. autofunction:: depend
-.. autofunction:: remote
-.. autofunction:: parallel
+.. autodecorator:: interactive
+.. autodecorator:: require
+.. autodecorator:: depend
+.. autodecorator:: remote
+.. autodecorator:: parallel
 
 
 Exceptions
 ----------
 
 .. autoexception:: RemoteError
+    :no-members:
 .. autoexception:: CompositeError
+    :no-members:
 .. autoexception:: NoEnginesRegistered
 .. autoexception:: ImpossibleDependency
 .. autoexception:: InvalidDependency

docs/source/conf.py

@@ -65,7 +65,6 @@
 # exclude members inherited from HasTraits by default
 autodoc_default_options = {
     'members': None,
-    "inherited-members": None,
     "exclude-members": ','.join(dir(LoggingConfigurable)),
 }
 

ipyparallel/client/asyncresult.py

@@ -369,7 +369,10 @@ def __dict__(self):
         return self.get_dict(0)
 
     def abort(self):
-        """abort my tasks."""
+        """Abort my tasks, if possible.
+
+        Only tasks that have not started yet can be aborted.
+        """
         assert not self.ready(), "Can't abort, I am already done!"
         return self._client.abort(self.msg_ids, targets=self._targets, block=True)
 

ipyparallel/client/client.py

@@ -1516,6 +1516,10 @@ def abort(self, jobs=None, targets=None, block=None):
 
         This is a mechanism to prevent jobs that have already been submitted
         from executing.
+        To halt a running job,
+        you must interrupt the engine(s) by sending a signal.
+        This can be done via os.kill for local engines,
+        or :meth:`.Cluster.signal_engines` for multiple engines.
 
         Parameters
         ----------

ipyparallel/client/view.py

@@ -269,6 +269,10 @@ def wait(self, jobs=None, timeout=-1):
     def abort(self, jobs=None, targets=None, block=None):
         """Abort jobs on my engines.
 
+        Note: only jobs that have not started yet can be aborted.
+        To halt a running job,
+        you must interrupt the engine(s) via the Cluster API.
+
         Parameters
         ----------
         jobs : None, str, list of strs, optional