documents system.cmp's platform specific behaviour; fixes #8930

2026-07-19 07:21:19 +00:00 · 2018-09-15 00:23:27 +02:00
parent 9995f50050
commit a34184bf88
1 changed files with 2 additions and 0 deletions
--- a/lib/system.nim
+++ b/lib/system.nim
@@ -1237,6 +1237,8 @@ proc cmp*[T](x, y: T): int {.procvar.} =

 proc cmp*(x, y: string): int {.noSideEffect, procvar.}
  ## Compare proc for strings. More efficient than the generic version.
+  ## **Note**: The precise result values depend on the used C runtime library and
+  ## can differ between operating systems!

 proc `@`* [IDX, T](a: array[IDX, T]): seq[T] {.
  magic: "ArrToSeq", nosideeffect.}