Changeset a12c0a6 in sasview for src


Ignore:
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:
1 added
2 edited

Legend:

Unmodified
Added
Removed
  • src/sas/guiframe/data_processor.py

    ra7aa5c7 ra12c0a6  
    99 
    1010The organization of the classes goes as: 
    11 #      ------------------------------------------------------------ 
    12 #      | --------------------------------------------------------  | 
    13 #      | | ----------------------------------------------------  | | 
    14 #      | | | ------------------------------------------------  | | | 
    15 #      | | | | --------------------------------------------  | | | | 
    16 #      | | | |                                               | | | | 
    17 #      | | | |                                               | | | | 
    18 #      | | | |     GridPage Class = the actual grid          | | | | 
    19 #      | | | |       GridCellEditor: overides class of same  | | | | 
    20 #      | | | |          name in the wx.CSheet module         | | | | 
    21 #      | | | |       BatchCell:  class defines a cell within | | | | 
    22 #      | | | |          within the grid                      | | | | 
    23 #      | | | |                                               | | | | 
    24 #      | | | |                                               | | | | 
    25 #      | | | ------------------------------------------------- | | | 
    26 #      | | |       Notebook class: contains all the GridPages  | | | 
    27 #      | | -----              ---------------------------------| | | 
    28 #      | |      |  Page 1     |                                  | | 
    29 #      | |      ---------------                                  | | 
    30 #      | |                                                       | | 
    31 #      | |    ----------------------------------------------     | | 
    32 #      | |                                                       | | 
    33 #      | |    Plotting area = a standard gridsizer               | | 
    34 #      | |     layout managed by the GridPanel class directly    | | 
    35 #      | |                                                       | | 
    36 #      | |    ----------------------------------------------     | | 
    37 #      | |                                                       | | 
    38 #      | |      GridPanel Class(SPanel(ScrolledPanel)            | | 
    39 #      | |         contains the GridPage and the 'plotting area' | | 
    40 #      | |         below it                                      | | 
    41 #      | --------------------------------------------------------- | 
    42 #      |                                                           | 
    43 #      |            GridFrame class(wx.Frame)                      | 
    44 #      ------------------------------------------------------------- 
     11.. image::  media/BatchGridClassLayout.png 
     12   :align:   center 
    4513 
    4614""" 
     
    8755    Return a dictionary of column label and index or row selected 
    8856     
    89     @param sentence: String to parse 
    90     @param list: list of columns label 
     57    :param sentence: String to parse 
     58    :param list: list of columns label 
    9159     
    9260    """ 
     
    182150        as is from sheet.CCellEditor.PaintBackground 
    183151         
    184         @param dc: the wxDC object for the paint 
     152        :param dc: the wxDC object for the paint 
    185153        ------- 
    186154        Draws the part of the cell not occupied by the edit control.  The 
     
    200168        Commit editing the current cell. Returns True if the value has changed. 
    201169         
    202         @param previous: previous value in the cell 
     170        :param previous: previous value in the cell 
    203171         
    204172        """ 
     
    696664        Add data to the grid 
    697665         
    698         @param data_inputs: data to use from the context menu of the grid 
    699         @param data_ouputs: default columns deplayed 
     666        :param data_inputs: data to use from the context menu of the grid 
     667        :param data_ouputs: default columns deplayed 
    700668         
    701669        """ 
     
    1029997        cells that can be used as data for one axis of a plot. 
    1030998         
    1031         @param cell_list: list of tuple 
     999        :param cell_list: list of tuple 
    10321000 
    10331001        """ 
     
    14871455        running "file:///...." 
    14881456 
    1489         @param evt: Triggers on clicking the help button 
     1457        :param evt: Triggers on clicking the help button 
    14901458 
    14911459        """ 
     
    16321600        cells. 
    16331601 
    1634         @param cell_list: list of tuple 
     1602        :param cell_list: list of tuple 
    16351603 
    16361604        """ 
     
    19831951        Initialize dialog 
    19841952 
    1985         @param parent: Window instantiating this dialog 
    1986         @param result: result to display in a grid or export to an external 
     1953        :param parent: Window instantiating this dialog 
     1954        :param result: result to display in a grid or export to an external 
    19871955                application. 
    19881956 
  • src/sas/guiframe/documentation_window.py

    r7a508b6 ra12c0a6  
    4444 
    4545    :param path: path to html file beginning AFTER /doc/ and ending in the 
    46     file.html 
    47     :param url_instructions: anchor string or other query e.g. '#MyAnchor 
    48     :param title - text to place in the title bar of the help panel 
     46    file.html. 
     47     
     48    :param url_instructions: anchor string or other query e.g. '#MyAnchor' 
     49    :param title: text to place in the title bar of the help panel 
    4950    """ 
    5051    def __init__(self, parent, dummy_id, path, url_instruction, title, size=(850, 540)): 
Note: See TracChangeset for help on using the changeset viewer.