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

Python: document writer.StructureField

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 62ee2fba..18bcb3ce 100644
--- a/bindings/python/writer.py
+++ b/bindings/python/writer.py
@@ -1324,9 +1324,16 @@ class FloatFieldingPoint(FloatingPointField):
 
 
 class StructureField(Field):
+    """
+    Structure field, based on a
+    :class:`StructureFieldDeclaration` object.
+    """
+
     def field(self, field_name):
         """
-        Get the structure's field corresponding to the provided field name.
+        Returns the structure :class:`Field` named *field_name*.
+
+        :exc:`ValueError` is raised on error.
         """
 
         native_instance = nbt._bt_ctf_field_structure_get_field(self._f,