summary refs log tree commit diff stats
diff options
context:
space:
mode:
authorDominik Picheta <dominikpicheta@googlemail.com>2015-10-27 21:03:55 +0100
committerDominik Picheta <dominikpicheta@googlemail.com>2015-10-27 21:03:55 +0100
commitb186493f0143fa8d977b4815e2ecda9f16a43b63 (patch)
treedf7968573968dc7e10abc105c1ff4a031780bf6a
parent82f3cab1ac02f482dc3de3a41099e1ec0a0819a7 (diff)
parentf68330e672d596f8e23e236ec941a29914a31255 (diff)
downloadNim-b186493f0143fa8d977b4815e2ecda9f16a43b63.tar.gz
Merge pull request #3475 from mjoud/shrdoc
fixed shr documentation
-rw-r--r--lib/system.nim9
1 files changed, 5 insertions, 4 deletions
diff --git a/lib/system.nim b/lib/system.nim
index 409691e6a..d611b64c0 100644
--- a/lib/system.nim
+++ b/lib/system.nim
@@ -868,12 +868,13 @@ proc `shr` *(x, y: int8): int8 {.magic: "ShrI", noSideEffect.}
 proc `shr` *(x, y: int16): int16 {.magic: "ShrI", noSideEffect.}
 proc `shr` *(x, y: int32): int32 {.magic: "ShrI", noSideEffect.}
 proc `shr` *(x, y: int64): int64 {.magic: "ShrI", noSideEffect.}
-  ## computes the `shift right` operation of `x` and `y`.
+  ## computes the `shift right` operation of `x` and `y`, filling
+  ## vacant bit positions with zeros.
   ##
   ## .. code-block:: Nim
-  ##   0b0001_0000'i8 shr 2 == 0b0100_0000'i8
-  ##   0b1000_0000'i8 shr 2 == 0b0000_0000'i8
-  ##   0b0000_0001'i8 shr 9 == 0b0000_0000'i8
+  ##   0b0001_0000'i8 shr 2 == 0b0000_0100'i8
+  ##   0b1000_0000'i8 shr 8 == 0b0000_0000'i8
+  ##   0b0000_0001'i8 shr 1 == 0b0000_0000'i8
 
 proc `shl` *(x, y: int): int {.magic: "ShlI", noSideEffect.}
 proc `shl` *(x, y: int8): int8 {.magic: "ShlI", noSideEffect.}