From 8eee0eb9c7389a24027ca5fc96d5abc3ca3e8b1b Mon Sep 17 00:00:00 2001 From: Philippe Proulx Date: Sat, 6 Dec 2014 16:39:13 -0500 Subject: [PATCH] Python: document SequenceFieldDeclaration MIME-Version: 1.0 Content-Type: text/plain; charset=utf8 Content-Transfer-Encoding: 8bit Signed-off-by: Philippe Proulx Signed-off-by: Jérémie Galarneau --- bindings/python/bt.py | 10 ++++++++-- 1 file changed, 8 insertions(+), 2 deletions(-) diff --git a/bindings/python/bt.py b/bindings/python/bt.py index 8015390c..dcdf3e30 100644 --- a/bindings/python/bt.py +++ b/bindings/python/bt.py @@ -1016,7 +1016,13 @@ class ArrayFieldDeclaration(FieldDeclaration): class SequenceFieldDeclaration(FieldDeclaration): - """Do not instantiate.""" + """ + Sequence (dynamic array) field declaration. + + .. note:: + + As of this version, this class is missing some properties. + """ def __init__(self): raise NotImplementedError("SequenceFieldDeclaration cannot be instantiated") @@ -1024,7 +1030,7 @@ class SequenceFieldDeclaration(FieldDeclaration): @property def element_declaration(self): """ - Return element declaration. + Underlying element's field declaration. """ field_decl_ptr = nbt._bt_python_get_sequence_element_declaration(self._fd) -- 2.34.1