Add docstring to Integer.bit_reverse method.

ponylang · Jun 8, 2018 · a4abcef · a4abcef
1 parent 30e6e6c
commit a4abcef
Showing 1 changed file with 5 additions and 0 deletions.
diff --git a/packages/builtin/real.pony b/packages/builtin/real.pony
@@ -258,6 +258,11 @@ trait val Integer[A: Integer[A] val] is Real[A]
   fun op_not(): A => not this
 
   fun bit_reverse(): A
+    """
+    Reverse the order of the bits within the integer.
+    For example, 0b11101101 (237) would return 0b10110111 (183).
+    """
+
   fun bswap(): A
 
 trait val _SignedInteger[A: _SignedInteger[A, B] val,