Changeset d138d43 in sasmodels for sasmodels/sasview_model.py

Timestamp:

Nov 30, 2015 2:24:28 PM (8 years ago)

Author:

Paul Kienzle <pkienzle@…>

Branches:

master, core_shell_microgels, costrafo411, magnetic_model, release_v0.94, release_v0.95, ticket-1257-vesicle-product, ticket_1156, ticket_1265_superball, ticket_822_more_unit_tests

Children:

eb69cce

Parents:

1ec7efa

Message:

remove documentation build errors

File:

• sasmodels/sasview_model.py (modified) (1 diff)

sasmodels/sasview_model.py

@@ -229 +229 @@
 
     def evalDistribution(self, qdist):
-        """
+        r"""
         Evaluate a distribution of q-values.
 
-        * For 1D, a numpy array is expected as input: ::
+        :param qdist: array of q or a list of arrays [qx,qy]
+
+        * For 1D, a numpy array is expected as input
+
+        ::
 
             evalDistribution(q)
 
-          where q is a numpy array.
-
-        * For 2D, a list of numpy arrays are expected: [qx,qy],
-          with 1D arrays::
+          where *q* is a numpy array.
+
+        * For 2D, a list of *[qx,qy]* is expected with 1D arrays as input
+
+        ::
 
               qx = [ qx[0], qx[1], qx[2], ....]
-
-          and::
-
               qy = [ qy[0], qy[1], qy[2], ....]
 
-        Then get ::
-
-            q = numpy.sqrt(qx^2+qy^2)
-
-        that is a qr in 1D array::
-
-            q = [q[0], q[1], q[2], ....]
-
-
-        :param qdist: ndarray of scalar q-values or list [qx,qy]
-        where qx,qy are 1D ndarrays
+        If the model is 1D only, then
+
+        .. math::
+
+            q = \sqrt{q_x^2+q_y^2}
+
         """
         if isinstance(qdist, (list, tuple)):