Changeset a26f67f in sasview for src/sas/sasgui/perspectives/file_converter

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

File:

• src/sas/sasgui/perspectives/file_converter/converter_panel.py (modified) (2 diffs)

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)