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 b431e21e428e3a569e57a65f33b9239848f0340f..769719a34b05f7a9bd1006dd137163209e2d9589 100644 (file)
--- 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")