From ed1ff4cfa113d38e7c3a79b27bb06ec8f11ade7d Mon Sep 17 00:00:00 2001
From: Philippe Proulx <eeppeliteloop@gmail.com>
Date: Sat, 6 Dec 2014 16:49:12 -0500
Subject: [PATCH] Python: document StringFieldDeclaration
MIME-Version: 1.0
Content-Type: text/plain; charset=utf8
Content-Transfer-Encoding: 8bit

Signed-off-by: Philippe Proulx <eeppeliteloop@gmail.com>
Signed-off-by: Jérémie Galarneau <jeremie.galarneau@efficios.com>
---
 bindings/python/bt.py | 8 +++++++-
 1 file changed, 7 insertions(+), 1 deletion(-)

diff --git a/bindings/python/bt.py b/bindings/python/bt.py
index b431e21e4..769719a34 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")
-- 
2.34.1