From: Philippe Proulx <eeppeliteloop@gmail.com>
Date: Wed, 10 Dec 2014 09:28:16 +0000 (-0500)
Subject: Python: document writer.IntegerField
X-Git-Url: http://drtracing.org/?a=commitdiff_plain;h=26912ff54b5e3caa448d285a0ca19cda8056d457;p=deliverable%2Fbabeltrace.git

Python: document writer.IntegerField

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 287e2256e..a1f83e9d7 100644
--- a/bindings/python/writer.py
+++ b/bindings/python/writer.py
@@ -1187,10 +1187,18 @@ class Field:
 
 
 class IntegerField(Field):
+    """
+    Integer field, based on an :class:`IntegerFieldDeclaration` object.
+    """
+
     @property
     def value(self):
         """
-        Get an integer field's value.
+        Integer value (:class:`int`).
+
+        Set this attribute to change the integer field's value.
+
+        :exc:`ValueError` or :exc:`TypeError` are raised on error.
         """
 
         signedness = nbt._bt_python_field_integer_get_signedness(self._f)
@@ -1210,10 +1218,6 @@ class IntegerField(Field):
 
     @value.setter
     def value(self, value):
-        """
-        Set an integer field's value.
-        """
-
         if not isinstance(value, int):
             raise TypeError("IntegerField's value must be an int")