added usage example for lower bound

1 files changed, 5 insertions, 0 deletions

diff --git a/lib/pure/algorithm.nim b/lib/pure/algorithm.nim
index fb0ba5355..49d1ac972 100644
--- a/lib/pure/algorithm.nim
+++ b/lib/pure/algorithm.nim
@@ -63,6 +63,11 @@ proc lowerBound*[T](a: openarray[T], key: T, cmp: proc(x,y: T): int {.closure.})
   ##
   ## `cmp` is the comparator function to use, the expected return values are the same as
   ## that of system.cmp
+  ## 
+  ## example:
+  ## `var arr = @[1,2,3,5,6,7,8,9]`
+  ## `arr.insert(4, arr.lowerBound(4))`
+  ## after running the above arr is `[1,2,3,4,5,6,7,8,9]`
   result = a.low
   var pos = result
   var count, step: int