Python: document writer.StringField

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 d862cd82a4f809c173800379410b4ae9cc9c15cd..f3a3f145d87f73268d1456045ec2dfc24e554392 100644 (file)
--- a/bindings/python/writer.py
+++ b/bindings/python/writer.py
@@ -1442,20 +1442,24 @@ class SequenceField(Field):
 
 
 class StringField(Field):
+    """
+    String (NULL-terminated array of bytes) field.
+    """
+
     @property
     def value(self):
         """
-        Get a string field's value.
+        String value (:class:`str`).
+
+        Set this attribute to change the string's value.
+
+        :exc:`ValueError` or :exc:`TypeError` are raised on error.
         """
 
         return nbt._bt_ctf_field_string_get_value(self._f)
 
     @value.setter
     def value(self, value):
-        """
-        Set a string field's value.
-        """
-
         ret = nbt._bt_ctf_field_string_set_value(self._f, str(value))
 
         if ret < 0: