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

Python: document StructureFieldDeclaration

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 19e307cd..b431e21e 100644
--- 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")