Changeset fb3f9af in sasview for src/sas

Timestamp:

Jul 26, 2015 6:28:26 PM (9 years ago)

Author:

butler

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:

ae2a197

Parents:

1f5f206

Message:

Fixes more sphinx doc build errors

Location:

src/sas

Files:

• guiframe/documentation_window.py (modified) (1 diff)
• models/MultiplicationModel.py (modified) (15 diffs)
• models/sas_extension/__init__.py (modified) (1 diff)

src/sas/guiframe/documentation_window.py

@@ -43 +43 @@
     (self, parent, dummy_id, path, url_instruction, title, size=(850, 540))
 
-    :param path: path to html file beginning AFTER /doc/ and ending in the
+    :param path: path to html file beginning AFTER /doc/ and ending in the\
     file.html.
-    
     :param url_instructions: anchor string or other query e.g. '#MyAnchor'
     :param title: text to place in the title bar of the help panel

src/sas/models/MultiplicationModel.py

@@ -10 +10 @@
         which will be calculated from P(Q) via calculate_ER(), 
         and 2) 'scale' in P model which is synchronized w/ volfraction in S 
-        then P*S is multiplied by a new param, 'scale_factor'.
+        then P*S is multiplied by a new parameter, 'scale_factor'.
         The polydispersion is applicable only to P(Q), not to S(Q).
-        Note: P(Q) refers to 'form factor' model while S(Q) does to 'structure factor'.
+
+        .. note:: P(Q) refers to 'form factor' model while S(Q) does to 'structure factor'.
     """
     def __init__(self, p_model, s_model ):
@@ -81 +82 @@
     def _clone(self, obj):
         """
-            Internal utility function to copy the internal
-            data members to a fresh copy.
+        Internal utility function to copy the internal data members to a
+        fresh copy.
         """
         obj.params     = copy.deepcopy(self.params)
@@ -96 +97 @@
     def _set_dispersion(self):
         """
-           combined the two models dispersions
-           Polydispersion should not be applied to s_model
+        combine the two models' dispersions. Polydispersity should not be
+        applied to s_model
         """
         ##set dispersion only from p_model 
@@ -107 +108 @@
         Get SLD profile of p_model if exists
         
-        : return: (r, beta) where r is a list of radius of the transition points
-                beta is a list of the corresponding SLD values 
-        : Note: This works only for func_shell num = 2 (exp function).
+        :return: (r, beta) where r is a list of radius of the transition points\
+                beta is a list of the corresponding SLD values
+
+        .. note:: This works only for func_shell num = 2 (exp function).
         """
         try:
@@ -121 +123 @@
     def _set_params(self):
         """
-            Concatenate the parameters of the two models to create
-            this model parameters 
+        Concatenate the parameters of the two models to create
+        these model parameters 
         """
 
@@ -141 +143 @@
     def _set_details(self):
         """
-            Concatenate details of the two models to create
-            this model details 
+        Concatenate details of the two models to create
+        this model's details 
         """
         for name, detail in self.p_model.details.iteritems():
@@ -154 +156 @@
     def _set_scale_factor(self):
         """
-            Set scale=volfraction to P model
+        Set scale=volfraction for P model
         """
         value = self.params['volfraction']
@@ -168 +170 @@
     def _set_effect_radius(self):
         """
-            Set effective radius to S(Q) model
+        Set effective radius to S(Q) model
         """
         if not 'effect_radius' in self.s_model.params.keys():
@@ -206 +208 @@
     def _setParamHelper(self, name, value):
         """
-            Helper function to setparam
+        Helper function to setparam
         """
         # Look for dispersion parameters
@@ -229 +231 @@
     def _set_fixed_params(self):
         """
-             fill the self.fixed list with the p_model fixed list
+        Fill the self.fixed list with the p_model fixed list
         """
         for item in self.p_model.fixed:
@@ -240 +242 @@
         """ 
         Evaluate the model
+        
         :param x: input q-value (float or [float, float] as [r, theta])
         :return: (scattering function value)
@@ -250 +253 @@
 
     def runXY(self, x = 0.0):
-        """ Evaluate the model
-            @param x: input q-value (float or [float, float] as [qx, qy])
-            @return: scattering function value
+        """ 
+        Evaluate the model
+        
+        :param x: input q-value (float or [float, float] as [qx, qy])
+        :return: scattering function value
         """  
         # set effective radius and scaling factor before run
@@ -266 +271 @@
         """ 
         Evaluate the model in cartesian coordinates
+        
         :param x: input q[], or [qx[], qy[]]
         :return: scattering function P(q[])
@@ -279 +285 @@
         """
         Set the dispersion object for a model parameter
+        
         :param parameter: name of the parameter [string]
         :dispersion: dispersion object of type DispersionModel
@@ -293 +300 @@
     def fill_description(self, p_model, s_model):
         """
-            Fill the description for P(Q)*S(Q)
+        Fill the description for P(Q)*S(Q)
         """
         description = ""

src/sas/models/sas_extension/__init__.py

@@ +1 @@
+"""
+This is an empty package - should probably delete
+"""