Skip to content

Commit

Permalink
some docstring edits
Browse files Browse the repository at this point in the history
  • Loading branch information
@butlerpd
butlerpd committed Jul 12, 2015
1 parent a7aa5c7 commit a12c0a6
Show file tree
Hide file tree
Showing 3 changed files with 17 additions and 48 deletions.
58 changes: 13 additions & 45 deletions src/sas/guiframe/data_processor.py
View file
Original file line number Diff line number Diff line change
Expand Up @@ -8,40 +8,8 @@
thus cannot feed back to the fitting panel. This could change in the future.
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
"""
import wx
Expand Down Expand Up @@ -86,8 +54,8 @@ def parse_string(sentence, list):
"""
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
"""

Expand Down Expand Up @@ -181,7 +149,7 @@ def PaintBackground(self, dc, rect, attr):
and in the call to the base class the rest of this method is copied
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
base class version just fills it with background colour from the
Expand All @@ -199,7 +167,7 @@ def EndEdit(self, row, col, grid, previous):
"""
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
"""
changed = False # Assume value not changed
Expand Down Expand Up @@ -695,8 +663,8 @@ def set_data(self, data_inputs, data_outputs, details, file_name):
"""
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
"""

Expand Down Expand Up @@ -1028,7 +996,7 @@ def create_axis_label(self, cell_list):
Receive a list of cells and create a string presenting the selected
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
"""
pos = self.GetSelection()
Expand Down Expand Up @@ -1486,7 +1454,7 @@ def on_help(self, event):
webbrowser does not pass anything past the # to the browser when it is
running "file:///...."
@param evt: Triggers on clicking the help button
:param evt: Triggers on clicking the help button
"""

Expand Down Expand Up @@ -1631,7 +1599,7 @@ def create_axis_label(self, cell_list):
Receive a list of cells and create a string presenting the selected
cells.
@param cell_list: list of tuple
:param cell_list: list of tuple
"""

Expand Down Expand Up @@ -1982,8 +1950,8 @@ def __init__(self, parent, data_inputs, data_outputs, file_name="",
"""
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.
"""
Expand Down
7 changes: 4 additions & 3 deletions src/sas/guiframe/documentation_window.py
View file
Original file line number Diff line number Diff line change
Expand Up @@ -43,9 +43,10 @@ class DocumentationWindow(wx.Frame):
(self, parent, dummy_id, path, url_instruction, title, size=(850, 540))
: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)):
wx.Frame.__init__(self, parent, dummy_id, title, size=size)
Expand Down
Binary file added src/sas/guiframe/media/BatchGridClassLayout.png
View file
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.

0 comments on commit a12c0a6

Please sign in to comment.