Changeset a26f67f in sasview for src/sas/sasgui/plottools/LineModel.py

Timestamp:

Sep 28, 2017 4:17:46 PM (7 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, magnetic_scatt, release-4.2.2, ticket-1009, ticket-1094-headless, ticket-1242-2d-resolution, ticket-1243, ticket-1249, ticket885, unittest-saveload

Children:

3bd677b

Parents:

59dfb53

Message:

fixup api doc errors

File:

• src/sas/sasgui/plottools/LineModel.py (modified) (4 diffs)

src/sas/sasgui/plottools/LineModel.py

@@ -2 +2 @@
 """
 Provide Line function (y= Ax + B). Until July 10, 2016 this function provided
-(y= A + Bx).  This however was contrary to all the other code using it which 
+(y= A + Bx).  This however was contrary to all the other code using it which
 assumed (y= mx+b) or in this nomenclature (y=Ax + B). This lead to some
 contortions in the code and worse incorrect calculations until now for at least
@@ -67 +67 @@
         Evaluate the model
 
-        :note: This is the function called by fitDialog to calculate the
-        the y(xmin) and y(xmax), but the only difference between this and
-        runXY is when the if statement is true. I however cannot see what that
-        function is for.  It needs to be documented here or removed.
-        PDB 7/10/16 
-
         :param x: simple value
 
         :return: (Line value)
+
+        .. note::
+            This is the function called by fitDialog to calculate the
+            the y(xmin) and y(xmax), but the only difference between this and
+            runXY is when the if statement is true. I however cannot see what
+            that function is for.  It needs to be documented here or removed.
+            PDB 7/10/16
         """
         if x.__class__.__name__ == 'list':
@@ -89 +90 @@
         """
         Evaluate the model.
-        
-        :note: This is to be what is called by fitDialog for the actual fit
-        but the only difference between this and run is when the if 
-        statement is true. I however cannot see what that function
-        is for.  It needs to be documented here or removed. PDB 7/10/16 
 
         :param x: simple value
@@ -99 +95 @@
         :return: Line value
 
+        .. note::
+            This is to be what is called by fitDialog for the actual fit
+            the only difference between this and run is when the if
+            statement is true. I however cannot see what that function
+            is for.  It needs to be documented here or removed. PDB 7/10/16
         """
         if x.__class__.__name__ == 'list':