From: Philippe Proulx <eeppeliteloop@gmail.com>
Date: Wed, 10 Dec 2014 17:16:14 +0000 (-0500)
Subject: Python: document writer.ArrayField
X-Git-Tag: v2.0.0-pre1~1357
X-Git-Url: http://git.efficios.com/?p=babeltrace.git;a=commitdiff_plain;h=a1bdc25c9f9b67530ae3b1f611cc505897f93363

Python: document writer.ArrayField

Signed-off-by: Philippe Proulx <eeppeliteloop@gmail.com>
Signed-off-by: Jérémie Galarneau <jeremie.galarneau@efficios.com>
---

diff --git a/bindings/python/writer.py b/bindings/python/writer.py
index 06664808..f50b9d51 100644
--- a/bindings/python/writer.py
+++ b/bindings/python/writer.py
@@ -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)