Changeset 51f14603 in sasview for src/sans/models/PowerLawAbsModel.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/models/PowerLawAbsModel.py (modified) (2 diffs)

src/sans/models/PowerLawAbsModel.py

@@ -1 +1 @@
 """ 
-    Provide F(x) = scale* (|x|)^(-m) + bkd
+    Provide F(x) = scale* (\|x\|)^(-m) + bkd
     Power law function as a BaseComponent model
 """
@@ -8 +8 @@
 class PowerLawAbsModel(PowerLawModel):
     """
-        Class that evaluates a absolute Power_Law model.
-        
+    Class that evaluates a absolute Power_Law model. ::
+    
         F(x) = scale* (|x|)^(-m) + bkd
-        
-        The model has three parameters: 
-            m     =  power
-            scale  =  scale factor
-            bkd    =  incoherent background
+    
+    The model has three parameters:
+
+    * m     =  power
+    * scale  =  scale factor
+    * bkd    =  incoherent background
     """