Add docstring to parseVersion

DIRACGrid · Sep 14, 2020 · ff74571 · ff74571
1 parent 4474ea2
commit ff74571
Showing 1 changed file with 5 additions and 0 deletions.
diff --git a/src/diraccfg/versions.py b/src/diraccfg/versions.py
@@ -7,6 +7,11 @@
 
 def parseVersion(versionString):
   """Parse a DIRAC-style version sting
+
+  :param versionString: Version identifier to parse
+  :returns: `tuple` of 4 values (major, minor, patch, pre). All values will be
+            `int` except "pre" which is `None` for released versions.
+  :raises: ValueError if the versionString is invalid
   """
   match = re.match(
       r"^v(?P<major>\d+)r(?P<minor>\d+)(?:p(?P<patch>\d+))?(?:-pre(?P<pre>\d+))?$",