Changeset ac7be54 in sasview for src/sas/calculator/sas_gen.py

Timestamp:

May 8, 2015 2:27:08 PM (9 years ago)

Author:

Paul Kienzle <pkienzle@…>

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:

5e880fe1

Parents:

c22c5e3

Message:

fix sphinx errors in api manual

File:

• src/sas/calculator/sas_gen.py (modified) (2 diffs)

src/sas/calculator/sas_gen.py

@@ -197 +197 @@
         """
         Evaluate a distribution of q-values.
-        * 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_prime,qy_prime], where 1D arrays.
-        :param qdist: ndarray of scalar q-values or list [qx,qy]
-                      where qx,qy are 1D ndarrays
+
+        :param qdist: ndarray of scalar q-values (for 1D) or list [qx,qy]
+                      where qx,qy are 1D ndarrays (for 2D).
         """
         if qdist.__class__.__name__ == 'list':
@@ -911 +908 @@
 
     def set_sldms(self, sld_mx, sld_my, sld_mz):
-        """
-        Sets (|m|, m_theta, m_phi)
+        r"""
+        Sets (\|m\|, m_theta, m_phi)
         """
         if sld_mx.__class__.__name__ == 'float':