[gnue] r8102 - in trunk/gnue-common/src: definitions events

[reinhard]

Author: reinhard
Date: 2005-11-21 01:42:56 -0600 (Mon, 21 Nov 2005)
New Revision: 8102

Modified:
   trunk/gnue-common/src/definitions/GObjects.py
   trunk/gnue-common/src/events/Event.py
   trunk/gnue-common/src/events/EventController.py
Log:
Fixed docstrings.


Modified: trunk/gnue-common/src/definitions/GObjects.py
===================================================================
--- trunk/gnue-common/src/definitions/GObjects.py       2005-11-21 07:39:13 UTC 
(rev 8101)
+++ trunk/gnue-common/src/definitions/GObjects.py       2005-11-21 07:42:56 UTC 
(rev 8102)
@@ -45,13 +45,13 @@
 
   This is the method of attribute access used by Designer and Reports.
   For example. if foo is a GObject, then the following are equivalent::
-      foo.required = 'Y'
-      foo['required'] = 'Y'
+    foo.required = 'Y'
+    foo['required'] = 'Y'
 
   The advantage of this method, however, is when namespaces are used
   in the GObj XML document (i.e., reports). e.g., ::
-     foo['Char:x'] = 1
-     foo['Char:y'] = 2
+    foo['Char:x'] = 1
+    foo['Char:y'] = 2
 
   These don't have a clean equivalent using the .attribute method.
   (Though, technically, a tool could access foo.Char__x, but that
@@ -558,15 +558,14 @@
   e.g., assume we have a XML tag 'goblin', that corresponds to a GObj-based
   class Goblin.  However, if <goblin style="boo"> we really need a BooGoblin
   object or if <goblin style="foo"> then we need a FooBoblin object, then the a
-  GoblinPlexor would define getClass as:
- 
-  def getClass (self):
-    if self.style == 'boo':
-      return BooGoblin
-    elif self.style == 'foo':
-      return FooGoblin
-    else:
-      return Goblin
+  GoblinPlexor would define getClass as::
+    def getClass (self):
+      if self.style == 'boo':
+        return BooGoblin
+      elif self.style == 'foo':
+        return FooGoblin
+      else:
+        return Goblin
   """
 
   # ---------------------------------------------------------------------------

Modified: trunk/gnue-common/src/events/Event.py
===================================================================
--- trunk/gnue-common/src/events/Event.py       2005-11-21 07:39:13 UTC (rev 
8101)
+++ trunk/gnue-common/src/events/Event.py       2005-11-21 07:42:56 UTC (rev 
8102)
@@ -61,10 +61,10 @@
       names of the events they wish to receive.
     @param data: B{OBSOLETE: Do not use}
     @param parms: Allows the event to accept any argument names you like.
-      Examples would be things like
-      - caller=self
-      - x=15
-      - vals = {'name': 'Bob', 'title': 'Mr'}
+      Examples would be things like::
+        caller = self
+        x = 15
+        vals = {'name': 'Bob', 'title': 'Mr'}
     """
 
     self.__dict__.update (parms)

Modified: trunk/gnue-common/src/events/EventController.py
===================================================================
--- trunk/gnue-common/src/events/EventController.py     2005-11-21 07:39:13 UTC 
(rev 8101)
+++ trunk/gnue-common/src/events/EventController.py     2005-11-21 07:42:56 UTC 
(rev 8102)
@@ -115,7 +115,7 @@
     """
     Dispatch or cache the given event.
 
-    @params event: L{Event} object or text identifying the type of event to be
+    @param event: L{Event} object or text identifying the type of event to be
       cached or dispatched.
     @returns: the event object's __result__ attribute
     """