From: Philippe Proulx <eeppeliteloop@gmail.com>
Date: Sat, 6 Dec 2014 21:48:30 +0000 (-0500)
Subject: Python: document FloatFieldDeclaration
X-Git-Url: http://drtracing.org/?a=commitdiff_plain;h=2847a2989a81f99c669d9d57cbbd0f7e782f9bcd;p=deliverable%2Fbabeltrace.git

Python: document FloatFieldDeclaration

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

diff --git a/bindings/python/bt.py b/bindings/python/bt.py
index dcdf3e307..19e307cda 100644
--- a/bindings/python/bt.py
+++ b/bindings/python/bt.py
@@ -1039,7 +1039,13 @@ class SequenceFieldDeclaration(FieldDeclaration):
 
 
 class FloatFieldDeclaration(FieldDeclaration):
-    """Do not instantiate."""
+    """
+    Floating point number field declaration.
+
+    .. note::
+
+       As of this version, this class is missing some properties.
+    """
 
     def __init__(self):
         raise NotImplementedError("FloatFieldDeclaration cannot be instantiated")