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 55c11eb6d3c3f9cf3a957e8f4a1aaabb2008db9e..ddedf06072f268d1d7d723723675cc9c1823491f 100644 (file)
--- 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