[gnue] r8792 - trunk/gnue-common/src/utils

[reinhard]

Author: reinhard
Date: 2006-10-16 05:10:36 -0500 (Mon, 16 Oct 2006)
New Revision: 8792

Modified:
   trunk/gnue-common/src/utils/version.py
Log:
Improved docstrings.


Modified: trunk/gnue-common/src/utils/version.py
===================================================================
--- trunk/gnue-common/src/utils/version.py      2006-10-16 09:43:21 UTC (rev 
8791)
+++ trunk/gnue-common/src/utils/version.py      2006-10-16 10:10:36 UTC (rev 
8792)
@@ -43,9 +43,9 @@
     be available.
 
     This function only works on POSIX systems. On other systems, it returns
-    "unknown".
+    C{'unknown'}.
 
-    If the environment variable "GNUE_BUILD" is set, the function returns 0.
+    If the environment variable C{GNUE_BUILD} is set, the function returns 0.
 
     @param directory: Source directory to check the revision for.
     """
@@ -102,6 +102,15 @@
     ===============
         A version number for a stable snapshot follows the format
         <major>.<minor>.<build>+svn.<svn> (e.g. 1.5.2+svn.9876).
+
+    @ivar major: Major version number
+    @ivar minor: Minor version number
+    @ivar phase: Phase of the release process. Can be C{'alpha'}, C{'beta'},
+        C{'pre'}, C{'rc'}, or C{'final'}. If the phase is C{'final'}, it is a
+        stable version, otherwise it is an unstable version.
+    @ivar build: Build number within the phase.
+    @ivar svn: SVN revision number. If this parameter is 0, the version is an
+        explicit build, otherwise it is an SVN snapshot.
     """
 
     __phases = {
@@ -121,13 +130,14 @@
 
         @param major: Major release number.
         @param minor: Minor release number.
-        @param phase: Phase of the release process. Can be 'alpha', 'beta',
-            'pre', 'rc', or 'final'. If the phase is 'final', it is a stable
-            version, otherwise it's an unstable version.
+        @param phase: Phase of the release process. Can be C{'alpha'},
+            C{'beta'}, C{'pre'}, C{'rc'}, or C{'final'}. If the phase is
+            C{'final'}, it is a stable version, otherwise it is an unstable
+            version.
         @param build: Build number within the phase.
         @param svn: SVN revision number. If this parameter is 0, the version is
-            an explicit build, otherwise it's an SVN snapshot. If this
-            parameter is Null, the SVN revision is determined automatically.
+            an explicit build, otherwise it is an SVN snapshot. If this
+            parameter is C{None}, the SVN revision is determined automatically.
         """
 
         assert isinstance (major, int) and major < 100
@@ -175,6 +185,7 @@
     def get_hexversion(self):
         """
         Return the version number as an eight character hexadecimal number.
+
         Later versions will always result in higher numbers.
         """