Author: bugman
Date: Thu Aug 11 15:59:14 2011
New Revision: 14357
URL: http://svn.gna.org/viewcvs/relax?rev=14357&view=rev
Log:
Epydoc docstring fixes.
Modified:
branches/gui_testing/gui/analyses/base.py
branches/gui_testing/gui/components/grid.py
branches/gui_testing/gui/components/relax_data.py
branches/gui_testing/gui/components/spectrum.py
branches/gui_testing/gui/errors.py
branches/gui_testing/gui/icons.py
branches/gui_testing/gui/misc.py
branches/gui_testing/gui/pipe_editor.py
branches/gui_testing/gui/results_viewer.py
branches/gui_testing/gui/user_functions/spectrum.py
branches/gui_testing/gui/user_functions/spin.py
Modified: branches/gui_testing/gui/analyses/base.py
URL:
http://svn.gna.org/viewcvs/relax/branches/gui_testing/gui/analyses/base.py?rev=14357&r1=14356&r2=14357&view=diff
==============================================================================
--- branches/gui_testing/gui/analyses/base.py (original)
+++ branches/gui_testing/gui/analyses/base.py Thu Aug 11 15:59:14 2011
@@ -52,7 +52,7 @@
width_button = 100
width_main_separator = 40
- def __init__(self, *args, **kwds):
+ def __init__(self, parent, id=wx.ID_ANY, pos=None, size=None,
style=None, name=None, gui=None):
"""Initialise the scrolled window.
@param parent: The parent wx element.
@@ -67,12 +67,10 @@
@type style: int
@keyword name: The name for the panel.
@type name: unicode
- @keyword gui: The main GUI class.
- @type gui: gui.relax_gui.Main instance
"""
# Execute the base class method.
- super(Base_analysis, self).__init__(*args, **kwds)
+ super(Base_analysis, self).__init__(parent, id=id, pos=pos,
size=size, style=style, name=name)
# Determine the size of the scrollers.
self.width_vscroll = wx.SystemSettings_GetMetric(wx.SYS_VSCROLL_X)
Modified: branches/gui_testing/gui/components/grid.py
URL:
http://svn.gna.org/viewcvs/relax/branches/gui_testing/gui/components/grid.py?rev=14357&r1=14356&r2=14357&view=diff
==============================================================================
--- branches/gui_testing/gui/components/grid.py (original)
+++ branches/gui_testing/gui/components/grid.py Thu Aug 11 15:59:14 2011
@@ -300,8 +300,8 @@
def add_buttons(self, sizer):
"""Add the buttons for peak list manipulation.
- @param box: The sizer element to pack the buttons into.
- @type box: wx.BoxSizer instance
+ @param sizer: The sizer element to pack the buttons into.
+ @type sizer: wx.BoxSizer instance
"""
# Button Sizer
@@ -345,8 +345,8 @@
def add_grid(self, sizer):
"""Add the grid for the peak list files and delay times.
- @param box: The sizer element to pack the grid into.
- @type box: wx.BoxSizer instance
+ @param sizer: The sizer element to pack the grid into.
+ @type sizer: wx.BoxSizer instance
"""
# Grid of peak list file names and relaxation time.
Modified: branches/gui_testing/gui/components/relax_data.py
URL:
http://svn.gna.org/viewcvs/relax/branches/gui_testing/gui/components/relax_data.py?rev=14357&r1=14356&r2=14357&view=diff
==============================================================================
--- branches/gui_testing/gui/components/relax_data.py (original)
+++ branches/gui_testing/gui/components/relax_data.py Thu Aug 11 15:59:14 2011
@@ -118,8 +118,8 @@
def add_buttons(self, sizer):
"""Add the buttons for peak list manipulation.
- @param box: The sizer element to pack the buttons into.
- @type box: wx.BoxSizer instance
+ @param sizer: The sizer element to pack the buttons into.
+ @type sizer: wx.BoxSizer instance
"""
# Button Sizer
@@ -198,8 +198,8 @@
def init_element(self, sizer):
"""Initialise the GUI element for the relaxation data listing.
- @param box: The sizer element to pack the element into.
- @type box: wx.BoxSizer instance
+ @param sizer: The sizer element to pack the element into.
+ @type sizer: wx.BoxSizer instance
"""
# List of relaxation data.
Modified: branches/gui_testing/gui/components/spectrum.py
URL:
http://svn.gna.org/viewcvs/relax/branches/gui_testing/gui/components/spectrum.py?rev=14357&r1=14356&r2=14357&view=diff
==============================================================================
--- branches/gui_testing/gui/components/spectrum.py (original)
+++ branches/gui_testing/gui/components/spectrum.py Thu Aug 11 15:59:14 2011
@@ -121,8 +121,8 @@
def add_buttons(self, sizer):
"""Add the buttons for peak list manipulation.
- @param box: The sizer element to pack the buttons into.
- @type box: wx.BoxSizer instance
+ @param sizer: The sizer element to pack the buttons into.
+ @type sizer: wx.BoxSizer instance
"""
# Button Sizer
@@ -203,8 +203,8 @@
def init_element(self, sizer):
"""Initialise the GUI element for the spectra listing.
- @param box: The sizer element to pack the element into.
- @type box: wx.BoxSizer instance
+ @param sizer: The sizer element to pack the element into.
+ @type sizer: wx.BoxSizer instance
"""
# List of peak list file names and relaxation time.
Modified: branches/gui_testing/gui/errors.py
URL:
http://svn.gna.org/viewcvs/relax/branches/gui_testing/gui/errors.py?rev=14357&r1=14356&r2=14357&view=diff
==============================================================================
--- branches/gui_testing/gui/errors.py (original)
+++ branches/gui_testing/gui/errors.py Thu Aug 11 15:59:14 2011
@@ -38,7 +38,7 @@
@type relax_error: RelaxError instance
@keyword raise_flag: A flag which if True will cause the error to be
raised, terminating execution.
@type raise_flag: bool
- @raises: The RelaxError.
+ @raises RelaxError: This raises all RelaxErrors, if the raise flag
is given.
"""
# Show a dialog explaining the error.
Modified: branches/gui_testing/gui/icons.py
URL:
http://svn.gna.org/viewcvs/relax/branches/gui_testing/gui/icons.py?rev=14357&r1=14356&r2=14357&view=diff
==============================================================================
--- branches/gui_testing/gui/icons.py (original)
+++ branches/gui_testing/gui/icons.py Thu Aug 11 15:59:14 2011
@@ -92,7 +92,7 @@
return popup
- def exit(self, evt):
+ def exit(self, event):
"""Exit relax from the task bar.
@param event: The wx event.
Modified: branches/gui_testing/gui/misc.py
URL:
http://svn.gna.org/viewcvs/relax/branches/gui_testing/gui/misc.py?rev=14357&r1=14356&r2=14357&view=diff
==============================================================================
--- branches/gui_testing/gui/misc.py (original)
+++ branches/gui_testing/gui/misc.py Thu Aug 11 15:59:14 2011
@@ -121,7 +121,7 @@
@param num: The boolean value of True or False.
@type num: bool
@return: The GUI string.
- @rtype: str
+ @rtype: unicode
"""
# Convert.
@@ -132,7 +132,7 @@
"""Method to convert a string like '1.02*1e-10' to a float variable.
@param string: The number in string form.
- @type string: str
+ @type string: str or unicode
@return: The floating point number.
@rtype: float
"""
@@ -159,7 +159,7 @@
"""Convert the GUI obtained string to an float.
@param string: The number in string form.
- @type string: str
+ @type string: str or unicode
@return: The float
@rtype: float or None
"""
@@ -191,7 +191,7 @@
"""Convert the GUI obtained string to an int.
@param string: The number in string form.
- @type string: str
+ @type string: str or unicode
@return: The integer
@rtype: int or None
"""
@@ -221,7 +221,7 @@
@param num: The number in float or None form.
@type num: float or None
@return: The GUI string.
- @rtype: str
+ @rtype: unicode
"""
# No input.
@@ -238,7 +238,7 @@
@param num: The number in int or None form.
@type num: int or None
@return: The GUI string.
- @rtype: str
+ @rtype: unicode
"""
# No input.
@@ -253,7 +253,7 @@
"""Convert the GUI obtained string to a bool.
@param string: The bool in string form.
- @type string: str
+ @type string: str or unicode
@return: The bool.
@rtype: bool
"""
@@ -270,7 +270,7 @@
"""Convert the GUI obtained string to a list.
@param string: The list in string form.
- @type string: str
+ @type string: str or unicode
@return: The list.
@rtype: list
"""
@@ -292,7 +292,7 @@
"""Convert the GUI obtained string to a string.
@param string: The number in string form.
- @type string: str
+ @type string: str or unicode
@return: The string.
@rtype: str
"""
@@ -309,9 +309,9 @@
"""Convert the list into the GUI string.
@param list: The Python list.
- @type list: list
- @return: The GUI string.
- @rtype: str
+ @type list: list or None
+ @return: The GUI string.
+ @rtype: unicode
"""
# No input.
@@ -376,10 +376,10 @@
def str_to_gui(string):
"""Convert the string into the GUI string.
- @param num: The number in int or None form.
- @type num: int or None
- @return: The GUI string.
- @rtype: str
+ @param string: The string or None to convert.
+ @type string: str or None
+ @return: The GUI string.
+ @rtype: unicode
"""
# No input.
Modified: branches/gui_testing/gui/pipe_editor.py
URL:
http://svn.gna.org/viewcvs/relax/branches/gui_testing/gui/pipe_editor.py?rev=14357&r1=14356&r2=14357&view=diff
==============================================================================
--- branches/gui_testing/gui/pipe_editor.py (original)
+++ branches/gui_testing/gui/pipe_editor.py Thu Aug 11 15:59:14 2011
@@ -248,8 +248,8 @@
def add_logo(self, box):
"""Add the logo to the sizer.
- @param sizer: The sizer element to pack the logo into.
- @type sizer: wx.Sizer instance
+ @param box: The sizer element to pack the logo into.
+ @type box: wx.Sizer instance
"""
# The pipe logo.
Modified: branches/gui_testing/gui/results_viewer.py
URL:
http://svn.gna.org/viewcvs/relax/branches/gui_testing/gui/results_viewer.py?rev=14357&r1=14356&r2=14357&view=diff
==============================================================================
--- branches/gui_testing/gui/results_viewer.py (original)
+++ branches/gui_testing/gui/results_viewer.py Thu Aug 11 15:59:14 2011
@@ -330,11 +330,7 @@
def update_pipes(self):
- """Update the data pipe list.
-
- @param event: The wx event.
- @type event: wx event
- """
+ """Update the data pipe list."""
# Clear the previous data pipe.
self.pipe_name.Clear()
Modified: branches/gui_testing/gui/user_functions/spectrum.py
URL:
http://svn.gna.org/viewcvs/relax/branches/gui_testing/gui/user_functions/spectrum.py?rev=14357&r1=14356&r2=14357&view=diff
==============================================================================
--- branches/gui_testing/gui/user_functions/spectrum.py (original)
+++ branches/gui_testing/gui/user_functions/spectrum.py Thu Aug 11 15:59:14
2011
@@ -134,11 +134,7 @@
def on_display(self):
- """Update the UI.
-
- @param event: The wx event.
- @type event: wx event
- """
+ """Update the UI."""
# Set the spectrum ID names.
if hasattr(cdp, 'spectrum_ids'):
@@ -207,11 +203,7 @@
def on_display(self):
- """Update the UI.
-
- @param event: The wx event.
- @type event: wx event
- """
+ """Update the UI."""
# Set the spectrum ID names.
if hasattr(cdp, 'spectrum_ids'):
@@ -334,11 +326,7 @@
def on_display(self):
- """Update the UI.
-
- @param event: The wx event.
- @type event: wx event
- """
+ """Update the UI."""
# Set the spectrum ID names.
if hasattr(cdp, 'spectrum_ids'):
Modified: branches/gui_testing/gui/user_functions/spin.py
URL:
http://svn.gna.org/viewcvs/relax/branches/gui_testing/gui/user_functions/spin.py?rev=14357&r1=14356&r2=14357&view=diff
==============================================================================
--- branches/gui_testing/gui/user_functions/spin.py (original)
+++ branches/gui_testing/gui/user_functions/spin.py Thu Aug 11 15:59:14 2011
@@ -237,11 +237,7 @@
def on_display(self):
- """Update the UI.
-
- @param event: The wx event.
- @type event: wx event
- """
+ """Update the UI."""
# Set the default pipe name.
if not gui_to_str(self.pipe_from.GetValue()):
r14357 - in /branches/gui_testing/gui: ./ analyses/ components/ user_functions/