r10555 - /branches/bieri_gui/gui_bieri/analyses/auto_rx_base.py -- January 28, 2010 - 19:50

Author: bugman
Date: Thu Jan 28 19:50:39 2010
New Revision: 10555

URL: http://svn.gna.org/viewcvs/relax?rev=10555&view=rev
Log:
Added a docstring and some comments to build_right_box().


Modified:
    branches/bieri_gui/gui_bieri/analyses/auto_rx_base.py

Modified: branches/bieri_gui/gui_bieri/analyses/auto_rx_base.py
URL: 
http://svn.gna.org/viewcvs/relax/branches/bieri_gui/gui_bieri/analyses/auto_rx_base.py?rev=10555&r1=10554&r2=10555&view=diff
==============================================================================
--- branches/bieri_gui/gui_bieri/analyses/auto_rx_base.py (original)
+++ branches/bieri_gui/gui_bieri/analyses/auto_rx_base.py Thu Jan 28 19:50:39 
2010
@@ -100,8 +100,15 @@
 
 
     def build_right_box(self):
+        """Construct the right hand box to pack into the main Rx box.
+
+        @return:    The right hand box element containing all Rx GUI 
elements (excluding the bitmap) to pack into the main Rx box.
+        @rtype:     wx.BoxSizer instance
+        """
+
+        # Use a vertical packing of elements.
         sizer_11 = wx.BoxSizer(wx.VERTICAL)
-        # R1 no. 1
+
         self.label_4_copy_copy = wx.StaticText(self.parent, -1, "Set-up for 
R1 relaxation analysis:")
         self.label_2_copy_copy_copy_2_copy = wx.StaticText(self.parent, -1, 
"NMR Frequency [MHz]:", style=wx.ALIGN_RIGHT)
         self.nmrfreq_value_r11 = wx.TextCtrl(self.parent, -1, 
str(self.data.frq))