Python: document writer.StructureField

[babeltrace.git] / bindings / python / writer.py

diff --git a/bindings/python/writer.py b/bindings/python/writer.py
index 62ee2fba3405556fbee31471b645cdb43f4070c6..18bcb3cee5cecf940e5ce5c2cefff97d0854ce5e 100644 (file)
--- 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,