Python: document writer.EnumerationMapping
authorPhilippe Proulx <eeppeliteloop@gmail.com>
Wed, 10 Dec 2014 00:34:41 +0000 (19:34 -0500)
committerJérémie Galarneau <jeremie.galarneau@efficios.com>
Tue, 17 Feb 2015 20:56:54 +0000 (15:56 -0500)
Signed-off-by: Philippe Proulx <eeppeliteloop@gmail.com>
Signed-off-by: Jérémie Galarneau <jeremie.galarneau@efficios.com>
bindings/python/writer.py

index fbcd68754745c5144f53c68c35fca09d8f5373e2..8e9c79f97bd5eb6a48a60493c78c08be4a3e00f8 100644 (file)
@@ -35,10 +35,18 @@ _MAX_UINT64 = 0xFFFFFFFFFFFFFFFF
 
 class EnumerationMapping:
     """
-    Enumeration mapping class. start and end values are inclusive.
+    Mapping from an enumeration label to a range of integers.
     """
 
     def __init__(self, name, start, end):
+        """
+        Creates an enumeration mapping, where label *name* is mapped to
+        the [*start*, *end*] range of integers (*end* is included).
+
+        Set *start* and *end* to the same value to create an enumeration
+        mapping to a single value.
+        """
+
         self.name = name
         self.start = start
         self.end = end
This page took 0.02539 seconds and 4 git commands to generate.