Changeset a26f67f in sasview

Timestamp:

Sep 28, 2017 6: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

Location:

src/sas

Files:

• sascalc/corfunc/corfunc_calculator.py (modified) (1 diff)
• sascalc/data_util/registry.py (modified) (1 diff)
• sascalc/file_converter/c_ext/__init__.py (modified) (1 diff)
• sasgui/guiframe/CategoryInstaller.py (modified) (1 diff)
• sasgui/guiframe/local_perspectives/plotting/parameters_panel_slicer.py (modified) (2 diffs)
• sasgui/perspectives/file_converter/converter_panel.py (modified) (2 diffs)
• sasgui/plottools/LineModel.py (modified) (4 diffs)

src/sas/sascalc/corfunc/corfunc_calculator.py

@@ -177 +177 @@
         """
         Extract the interesting measurements from a correlation function
-        :param transformed_data: Fourier transformation of the
-            extrapolated data
+
+        :param transformed_data: Fourier transformation of the extrapolated data
         """
         # Calculate indexes of maxima and minima

src/sas/sascalc/data_util/registry.py

@@ -121 +121 @@
         Call the loader for the file type of path.
 
-        :raise ValueError: if no loader is available.
-        :raise KeyError: if format is not available.
+        :raises ValueError: if no loader is available.
+        :raises KeyError: if format is not available.
+
         May raise a loader-defined exception if loader fails.
         """

src/sas/sascalc/file_converter/c_ext/__init__.py

@@ +1 @@
+"""
+    Data loader for the Diamond BSL beamline.
+"""

src/sas/sasgui/guiframe/CategoryInstaller.py

@@ -112 +112 @@
     def check_install(homedir = None, model_list=None):
         """
-        the main method of this class
-        makes sure categories.json exists and if not
-        compile it and install
+        Makes sure categories.json exists and if not compile it and install.
+
+        This is the main method of this class.
+
         :param homefile: Override the default home directory
-        :param model_list: List of model names except those in Plugin Models
-               which are user supplied.
+        :param model_list: List of model names except those in
+            Plugin Models which are user supplied.
         """
         _model_dict = {model.name: model for model in model_list}

src/sas/sasgui/guiframe/local_perspectives/plotting/parameters_panel_slicer.py

@@ -395 +395 @@
         """
         Event based parameter setting.
+
         :param evt: Event triggered to apply parameters to a list of plots
-                    evt should have attrs plot_list and params
+           evt should have attrs plot_list and params
+
         """
         if evt is None:
@@ -467 +469 @@
         """
         Send a list of data to the fitting perspective
-        :param fit: fit type desired 
+        :param fit: fit type desired
         :param file_list: list of loaded file names to send to fit
         """

src/sas/sasgui/perspectives/file_converter/converter_panel.py

@@ -93 +93 @@
         <SasData> element.
 
-        :param frame_data: If single_file is true, an array of Data1D objects.
-        If single_file is false, a dictionary of the form frame_number: Data1D.
+        :param frame_data: If single_file is true, an array of Data1D
+            objects. If single_file is false, a dictionary of the
+            form *{frame_number: Data1D}*.
         :param filepath: Where to save the CanSAS file
-        :param single_file: If true, array is saved as a single file, if false,
-        each item in the array is saved to it's own file
+        :param single_file: If true, array is saved as a single file,
+            if false, each item in the array is saved to it's own file
         """
         writer = CansasWriter()
@@ -192 +193 @@
         :return x_data: A 1D array containing all the x coordinates of the data
         :return y_data: A 1D array containing all the y coordinates of the data
-        :return frame_data: A dictionary of the form frame_number: data, where
-        data is a 2D numpy array containing the intensity data
+        :return frame_data: A dictionary of the form *{frame_number: data}*, where data is a 2D numpy array containing the intensity data
         """
         loader = BSLLoader(filename)

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':