From: Philippe Proulx <eeppeliteloop@gmail.com>
Date: Sat, 6 Dec 2014 01:03:40 +0000 (-0500)
Subject: Python: document ByteOrder
X-Git-Tag: v2.0.0-pre1~1392
X-Git-Url: http://git.efficios.com/?p=babeltrace.git;a=commitdiff_plain;h=414751154ea9ff8cda0a162b93b99f0342dceec4

Python: document ByteOrder

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 55c11eb6..ddedf060 100644
--- a/bindings/python/bt.py
+++ b/bindings/python/bt.py
@@ -346,10 +346,23 @@ class CTFStringEncoding:
 
 # Based on the enum in ctf-writer/writer.h
 class ByteOrder:
+    """
+    Byte orders.
+    """
+
+    #: Native byte order
     BYTE_ORDER_NATIVE = 0
+
+    #: Little-endian
     BYTE_ORDER_LITTLE_ENDIAN = 1
+
+    #: Big-endian
     BYTE_ORDER_BIG_ENDIAN = 2
+
+    #: Network byte order (big-endian)
     BYTE_ORDER_NETWORK = 3
+
+    #: Unknown byte order
     BYTE_ORDER_UNKNOWN = 4  # Python-specific entry