From c0a2c1b7b080016198dbd79201a2246a5668099b Mon Sep 17 00:00:00 2001 From: Philippe Proulx Date: Sat, 6 Dec 2014 16:37:57 -0500 Subject: [PATCH] Python: document ArrayFieldDeclaration 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, 6 insertions(+), 4 deletions(-) diff --git a/bindings/python/bt.py b/bindings/python/bt.py index 8f55f28c..8015390c 100644 --- a/bindings/python/bt.py +++ b/bindings/python/bt.py @@ -988,7 +988,9 @@ class EnumerationFieldDeclaration(FieldDeclaration): class ArrayFieldDeclaration(FieldDeclaration): - """Do not instantiate.""" + """ + Static array field declaration. + """ def __init__(self): raise NotImplementedError("ArrayFieldDeclaration cannot be instantiated") @@ -996,8 +998,8 @@ class ArrayFieldDeclaration(FieldDeclaration): @property def length(self): """ - Return the length of an array or a negative - value on error. + Static array's fixed length (number of contained elements), or + a negative value on error. """ return nbt._bt_ctf_get_array_len(self._fd) @@ -1005,7 +1007,7 @@ class ArrayFieldDeclaration(FieldDeclaration): @property def element_declaration(self): """ - Return element declaration. + Underlying element's field declaration. """ field_decl_ptr = nbt._bt_python_get_array_element_declaration(self._fd) -- 2.34.1