Python: document StructureFieldDeclaration

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

diff --git a/bindings/python/bt.py b/bindings/python/bt.py
index 19e307cda1c16aa2e303f20c92b3fd9a963c7ccd..b431e21e428e3a569e57a65f33b9239848f0340f 100644 (file)
--- a/bindings/python/bt.py
+++ b/bindings/python/bt.py
@@ -1052,7 +1052,14 @@ class FloatFieldDeclaration(FieldDeclaration):
 
 
 class StructureFieldDeclaration(FieldDeclaration):
-    """Do not instantiate."""
+    """
+    Structure (ordered map of field names to field declarations) field
+    declaration.
+
+    .. note::
+
+       As of this version, this class is missing some properties.
+    """
 
     def __init__(self):
         raise NotImplementedError("StructureFieldDeclaration cannot be instantiated")