r11980 - in /branches/bieri_gui: doc_builder.py gui_bieri/about.py gui_bieri/components/conversion.py gui_bieri/filedialog.py -- December 27, 2010 - 17:23

Author: bugman
Date: Mon Dec 27 17:23:11 2010
New Revision: 11980

URL: http://svn.gna.org/viewcvs/relax?rev=11980&view=rev
Log:
Epydoc docstring fixes.


Modified:
    branches/bieri_gui/doc_builder.py
    branches/bieri_gui/gui_bieri/about.py
    branches/bieri_gui/gui_bieri/components/conversion.py
    branches/bieri_gui/gui_bieri/filedialog.py

Modified: branches/bieri_gui/doc_builder.py
URL: 
http://svn.gna.org/viewcvs/relax/branches/bieri_gui/doc_builder.py?rev=11980&r1=11979&r2=11980&view=diff
==============================================================================
--- branches/bieri_gui/doc_builder.py (original)
+++ branches/bieri_gui/doc_builder.py Mon Dec 27 17:23:11 2010
@@ -36,7 +36,7 @@
     """Convert the text to that of a docstring, dependent on the text level.
 
     @param data:    The lists of constants and text to convert into a 
properly formatted docstring.
-    @type text:     list of lists of int and str
+    @type data:     list of lists of int and str
     """
 
     # Init.

Modified: branches/bieri_gui/gui_bieri/about.py
URL: 
http://svn.gna.org/viewcvs/relax/branches/bieri_gui/gui_bieri/about.py?rev=11980&r1=11979&r2=11980&view=diff
==============================================================================
--- branches/bieri_gui/gui_bieri/about.py (original)
+++ branches/bieri_gui/gui_bieri/about.py Mon Dec 27 17:23:11 2010
@@ -88,11 +88,7 @@
 
 
     def create_buffered_dc(self):
-        """Build the buffered dc containing the window contents.
-
-        @param event:   The wx event.
-        @type event:    wx event
-        """
+        """Build the buffered dc containing the window contents."""
 
         # Dimensions of the drawing area.
         if self.max_x:

Modified: branches/bieri_gui/gui_bieri/components/conversion.py
URL: 
http://svn.gna.org/viewcvs/relax/branches/bieri_gui/gui_bieri/components/conversion.py?rev=11980&r1=11979&r2=11980&view=diff
==============================================================================
--- branches/bieri_gui/gui_bieri/components/conversion.py (original)
+++ branches/bieri_gui/gui_bieri/components/conversion.py Mon Dec 27 17:23:11 
2010
@@ -32,8 +32,8 @@
     such as:    "3.5 * 1e6" to 3.5*1e6
 
 
-    @keyword string     Float in string that will be converted to float 
object.
-    @type string        str
+    @param string:  Float in string that will be converted to float object.
+    @type string:   str
     """
 
     # Delete whitespace.

Modified: branches/bieri_gui/gui_bieri/filedialog.py
URL: 
http://svn.gna.org/viewcvs/relax/branches/bieri_gui/gui_bieri/filedialog.py?rev=11980&r1=11979&r2=11980&view=diff
==============================================================================
--- branches/bieri_gui/gui_bieri/filedialog.py (original)
+++ branches/bieri_gui/gui_bieri/filedialog.py Mon Dec 27 17:23:11 2010
@@ -32,8 +32,10 @@
 def multi_openfile(msg=None, directory=None, filetype='', default=None):
     """Open multiple files.
 
-    For example to open /usr/save.relaxGUI, where the supported files to 
open are: *.relaxGUI, *.*:
+    For example to open /usr/save.relaxGUI, where the supported files to 
open are: *.relaxGUI, *.*::
+
         multi_openfile('select file to open', '/usr', 'save.relaxGUI', 
'relaxGUI files (*.relaxGUI)|*.relaxGUI|all files (*.*)|*.*')
+
 
     @keyword msg:       The message to display.
     @type msg:          str
@@ -75,7 +77,8 @@
 def openfile(msg=None, directory=None, filetype='*', default='all files 
(*.*)|*'):
     """Open a file.
 
-    For example to open /usr/save.relaxGUI, where the supported files to 
open are: *.relaxGUI, *.*:
+    For example to open /usr/save.relaxGUI, where the supported files to 
open are: *.relaxGUI, *.*::
+
         openfile('select file to open', '/usr', 'save.relaxGUI', 'relaxGUI 
files (*.relaxGUI)|*.relaxGUI|all files (*.*)|*.*')
 
 
@@ -111,7 +114,8 @@
 def savefile(msg=None, directory=None, filetype='', default=None):
     """Save a file.
 
-    For example to save /usr/save.relaxGUI, where the supported files to 
open are: *.relaxGUI, *.*:
+    For example to save /usr/save.relaxGUI, where the supported files to 
open are: *.relaxGUI, *.*::
+
         savefile('select file to save', '/usr', 'save.relaxGUI', 'relaxGUI 
files (*.relaxGUI)|*.relaxGUI|all files (*.*)|*.*')