Changeset a12c0a6 in sasview for src/sas

Timestamp:

Jul 12, 2015 7:53:51 PM (9 years ago)

Author:

butler

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:

9df6a03

Parents:

a7aa5c7

Message:

some docstring edits

Location:

src/sas/guiframe

Files:

• data_processor.py (modified) (9 diffs)
• documentation_window.py (modified) (1 diff)
• media/BatchGridClassLayout.png (added)

src/sas/guiframe/data_processor.py

@@ -9 +9 @@
 
 The organization of the classes goes as:
-#      ------------------------------------------------------------
-#      | --------------------------------------------------------  |
-#      | | ----------------------------------------------------  | |
-#      | | | ------------------------------------------------  | | |
-#      | | | | --------------------------------------------  | | | |
-#      | | | |                                               | | | |
-#      | | | |                                               | | | |
-#      | | | |     GridPage Class = the actual grid          | | | |
-#      | | | |       GridCellEditor: overides class of same  | | | |
-#      | | | |          name in the wx.CSheet module         | | | |
-#      | | | |       BatchCell:  class defines a cell within | | | |
-#      | | | |          within the grid                      | | | |
-#      | | | |                                               | | | |
-#      | | | |                                               | | | |
-#      | | | ------------------------------------------------- | | |
-#      | | |       Notebook class: contains all the GridPages  | | |
-#      | | -----              ---------------------------------| | |
-#      | |      |  Page 1     |                                  | |
-#      | |      ---------------                                  | |
-#      | |                                                       | |
-#      | |    ----------------------------------------------     | |
-#      | |                                                       | |
-#      | |    Plotting area = a standard gridsizer               | |
-#      | |     layout managed by the GridPanel class directly    | |
-#      | |                                                       | |
-#      | |    ----------------------------------------------     | |
-#      | |                                                       | |
-#      | |      GridPanel Class(SPanel(ScrolledPanel)            | |
-#      | |         contains the GridPage and the 'plotting area' | |
-#      | |         below it                                      | |
-#      | --------------------------------------------------------- |
-#      |                                                           |
-#      |            GridFrame class(wx.Frame)                      |
-#      -------------------------------------------------------------
+.. image::  media/BatchGridClassLayout.png
+   :align:   center
 
 """
@@ -87 +55 @@
     Return a dictionary of column label and index or row selected
     
-    @param sentence: String to parse
-    @param list: list of columns label
+    :param sentence: String to parse
+    :param list: list of columns label
     
     """
@@ -182 +150 @@
         as is from sheet.CCellEditor.PaintBackground
         
-        @param dc: the wxDC object for the paint
+        :param dc: the wxDC object for the paint
         -------
         Draws the part of the cell not occupied by the edit control.  The
@@ -200 +168 @@
         Commit editing the current cell. Returns True if the value has changed.
         
-        @param previous: previous value in the cell
+        :param previous: previous value in the cell
         
         """
@@ -696 +664 @@
         Add data to the grid
         
-        @param data_inputs: data to use from the context menu of the grid
-        @param data_ouputs: default columns deplayed
+        :param data_inputs: data to use from the context menu of the grid
+        :param data_ouputs: default columns deplayed
         
         """
@@ -1029 +997 @@
         cells that can be used as data for one axis of a plot.
         
-        @param cell_list: list of tuple
+        :param cell_list: list of tuple
 
         """
@@ -1487 +1455 @@
         running "file:///...."
 
-        @param evt: Triggers on clicking the help button
+        :param evt: Triggers on clicking the help button
 
         """
@@ -1632 +1600 @@
         cells.
 
-        @param cell_list: list of tuple
+        :param cell_list: list of tuple
 
         """
@@ -1983 +1951 @@
         Initialize dialog
 
-        @param parent: Window instantiating this dialog
-        @param result: result to display in a grid or export to an external
+        :param parent: Window instantiating this dialog
+        :param result: result to display in a grid or export to an external
                 application.
 

src/sas/guiframe/documentation_window.py

@@ -44 +44 @@
 
     :param path: path to html file beginning AFTER /doc/ and ending in the
-    file.html
-    :param url_instructions: anchor string or other query e.g. '#MyAnchor
-    :param title - text to place in the title bar of the help panel
+    file.html.
+    
+    :param url_instructions: anchor string or other query e.g. '#MyAnchor'
+    :param title: text to place in the title bar of the help panel
     """
     def __init__(self, parent, dummy_id, path, url_instruction, title, size=(850, 540)):