From: Philippe Proulx <eeppeliteloop@gmail.com>
Date: Sat, 6 Dec 2014 21:37:43 +0000 (-0500)
Subject: Python: document EnumerationFieldDeclaration
X-Git-Tag: v2.0.0-pre1~1385
X-Git-Url: http://git.efficios.com/?a=commitdiff_plain;h=13e9bbf593141aef5ce99854fc8d81644883af59;p=babeltrace.git

Python: document EnumerationFieldDeclaration

Signed-off-by: Philippe Proulx <eeppeliteloop@gmail.com>
Signed-off-by: Jérémie Galarneau <jeremie.galarneau@efficios.com>
---

diff --git a/bindings/python/bt.py b/bindings/python/bt.py
index e79a61bb..8f55f28c 100644
--- a/bindings/python/bt.py
+++ b/bindings/python/bt.py
@@ -975,7 +975,13 @@ class IntegerFieldDeclaration(FieldDeclaration):
 
 
 class EnumerationFieldDeclaration(FieldDeclaration):
-    """Do not instantiate."""
+    """
+    Enumeration field declaration.
+
+    .. note::
+
+       As of this version, this class is missing some properties.
+    """
 
     def __init__(self):
         raise NotImplementedError("EnumerationFieldDeclaration cannot be instantiated")