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

Python: document CTFScope

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 6091bdb9c..9714eb439 100644
--- a/bindings/python/bt.py
+++ b/bindings/python/bt.py
@@ -427,14 +427,33 @@ class CTFTypeId:
 
 
 class CTFScope:
+    """
+    CTF scopes.
+    """
+
+    #: Packet header
     TRACE_PACKET_HEADER = 0
+
+    #: Packet context
     STREAM_PACKET_CONTEXT = 1
+
+    #: Event header
     STREAM_EVENT_HEADER = 2
+
+    #: Stream event context
     STREAM_EVENT_CONTEXT = 3
+
+    #: Event context
     EVENT_CONTEXT = 4
+
+    #: Event fields
     EVENT_FIELDS = 5
 
     def scope_name(scope):
+        """
+        Returns the name of the CTF scope *scope*.
+        """
+
         name = "UNKNOWN_SCOPE"
         constants = [
             attr for attr in dir(CTFScope) if not callable(