Python: document writer.ArrayField
authorPhilippe Proulx <eeppeliteloop@gmail.com>
Wed, 10 Dec 2014 17:16:14 +0000 (12:16 -0500)
committerJérémie Galarneau <jeremie.galarneau@efficios.com>
Tue, 17 Feb 2015 21:11:54 +0000 (16:11 -0500)
Signed-off-by: Philippe Proulx <eeppeliteloop@gmail.com>
Signed-off-by: Jérémie Galarneau <jeremie.galarneau@efficios.com>
bindings/python/writer.py

index 06664808f0d4088f6c36129424ecccc309981bbc..f50b9d51fc25ec252cf9333fbf7a51f9e76ff9e3 100644 (file)
@@ -1368,9 +1368,17 @@ class VariantField(Field):
 
 
 class ArrayField(Field):
+    """
+    Static array field, based on an
+    :class:`ArrayFieldDeclaration` object.
+    """
+
     def field(self, index):
         """
-        Return the array's field at position "index".
+        Returns the :class:`Field` at index *index* in this static
+        array.
+
+        :exc:`IndexError` is raised on error.
         """
 
         native_instance = nbt._bt_ctf_field_array_get_field(self._f, index)
This page took 0.025902 seconds and 5 git commands to generate.