Python: document EnumerationFieldDeclaration

[babeltrace.git] / bindings / python / bt.py

diff --git a/bindings/python/bt.py b/bindings/python/bt.py
index e79a61bbc9e829b179653a45f80bea1fe26b6289..8f55f28c5fb47cd967edaa513bd0eef3f541e8dd 100644 (file)
--- 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")