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

Python: document StringFieldDeclaration

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 b431e21e..769719a3 100644
--- a/bindings/python/bt.py
+++ b/bindings/python/bt.py
@@ -1066,7 +1066,13 @@ class StructureFieldDeclaration(FieldDeclaration):
 
 
 class StringFieldDeclaration(FieldDeclaration):
-    """Do not instantiate."""
+    """
+    String (NULL-terminated array of bytes) field declaration.
+
+    .. note::
+
+       As of this version, this class is missing some properties.
+    """
 
     def __init__(self):
         raise NotImplementedError("StringFieldDeclaration cannot be instantiated")