Changeset 51f14603 in sasview for src/sans/data_util/calcthread.py

Timestamp:

Apr 3, 2014 11:37:53 AM (11 years ago)

Author:

Peter Parker

Branches:

master, ESS_GUI, ESS_GUI_Docs, ESS_GUI_batch_fitting, ESS_GUI_bumps_abstraction, ESS_GUI_iss1116, ESS_GUI_iss879, ESS_GUI_iss959, ESS_GUI_opencl, ESS_GUI_ordering, ESS_GUI_sync_sascalc, costrafo411, magnetic_scatt, release-4.1.1, release-4.1.2, release-4.2.2, release_4.0.1, ticket-1009, ticket-1094-headless, ticket-1242-2d-resolution, ticket-1243, ticket-1249, ticket885, unittest-saveload

Children:

2f2d9d0

Parents:

eea3ffa

Message:

Refs #202 - Fix Sphinx build errors (not including park-1.2.1/). Most warnings remain.

File:

• src/sans/data_util/calcthread.py (modified) (4 diffs)

src/sans/data_util/calcthread.py

@@ -33 +33 @@
     
     When defining the compute() method you need to include code which
-    allows the GUI to run.  They are as follows:
-        self.isquit()          call frequently to check for interrupts
-        self.update(kw=...)    call when the GUI could be updated
-        self.complete(kw=...)  call before exiting compute()
+    allows the GUI to run.  They are as follows: ::
+
+        self.isquit()          # call frequently to check for interrupts
+        self.update(kw=...)    # call when the GUI could be updated
+        self.complete(kw=...)  # call before exiting compute()
+
     The update() and complete() calls accept field=value keyword
     arguments which are passed to the called function.  complete()
@@ -46 +48 @@
     of the derived class.
 
-    The user of this class will call the following:
-
-        thread = Work(...,kw=...)  prepare the work thread.
-        thread.queue(...,kw=...)   queue a work unit
-        thread.requeue(...,kw=...) replace work unit on the end of queue
-        thread.reset(...,kw=...)   reset the queue to the given work unit
-        thread.stop()              clear the queue and halt
-        thread.interrupt()         halt the current work unit but continue
-        thread.ready(delay=0.)     request an update signal after delay
-        thread.isrunning()         returns true if compute() is running
+    The user of this class will call the following: ::
+
+        thread = Work(...,kw=...)  # prepare the work thread.
+        thread.queue(...,kw=...)   # queue a work unit
+        thread.requeue(...,kw=...) # replace work unit on the end of queue
+        thread.reset(...,kw=...)   # reset the queue to the given work unit
+        thread.stop()              # clear the queue and halt
+        thread.interrupt()         # halt the current work unit but continue
+        thread.ready(delay=0.)     # request an update signal after delay
+        thread.isrunning()         # returns true if compute() is running
 
     Use queue() when all work must be done.  Use requeue() when intermediate
@@ -63 +65 @@
     stop() to halt the current and pending computations (e.g., in response to
     a stop button).
-    
+
     The methods queue(), requeue() and reset() are proxies for the compute()
     method in the subclass.  Look there for a description of the arguments.
@@ -82 +84 @@
     should be implemented vary from framework to framework.
 
-    For wx, something like the following is needed:
+    For wx, something like the following is needed: ::
 
         import wx, wx.lib.newevent