Changeset 51f14603 in sasview for src/sans/fit

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.

Location:

src/sans/fit

Files:

• AbstractFitEngine.py (modified) (2 diffs)
• ParkFitting.py (modified) (2 diffs)

src/sans/fit/AbstractFitEngine.py

@@ -557 +557 @@
         
         :param model: sans.models type 
-        :param : is the key of the fitArrange dictionary where model is 
-                saved as a value
+        :param id: is the key of the fitArrange dictionary where model is saved as a value
         :param pars: the list of parameters to fit 
         :param constraints: list of 
@@ -566 +565 @@
             Example:  
             we want to fit 2 model M1 and M2 both have parameters A and B.
-            constraints can be:
-             constraints = [(M1.A, M2.B+2), (M1.B= M2.A *5),...,]
+            constraints can be ``constraints = [(M1.A, M2.B+2), (M1.B= M2.A *5),...,]``
             
              

src/sans/fit/ParkFitting.py

@@ -315 +315 @@
     Set model parameter "M1"= model.name add {model.parameter.name:value}.
     
-    :note: Set_param() if used must always preceded set_model()
-         for the fit to be performed.
-    engine.set_param( model,"M1", {'A':2,'B':4})
+    ..note::
+       Set_param() if used must always preceded set_model() for the fit to be performed.
+      ``engine.set_param( model,"M1", {'A':2,'B':4})``
     
     Add model with a dictionnary of FitArrangeList{} where Uid is a key
@@ -327 +327 @@
     chisqr1, out1, cov1=engine.fit({model.parameter.name:value},qmin,qmax)
     
-    :note: {model.parameter.name:value} is ignored in fit function since 
+    ..note::
+        {model.parameter.name:value} is ignored in fit function since 
         the user should make sure to call set_param himself.