summary refs log tree commit diff stats
path: root/lib/system.nim
diff options
context:
space:
mode:
authorflywind <xzsflywind@gmail.com>2021-10-03 13:22:53 +0800
committerGitHub <noreply@github.com>2021-10-03 07:22:53 +0200
commit45c4332c81521224a4db90fe9bf46efc0f93aaf7 (patch)
treed3d594453557902028d402f6cd750dfd5bdc880a /lib/system.nim
parente9268b52d9a34e7e851105d569bccced4b7261fd (diff)
downloadNim-45c4332c81521224a4db90fe9bf46efc0f93aaf7.tar.gz
document -d:nimStrictDelete [backport] (#18939)
Diffstat (limited to 'lib/system.nim')
-rw-r--r--lib/system.nim4
1 files changed, 4 insertions, 0 deletions
diff --git a/lib/system.nim b/lib/system.nim
index 358aae938..caa036f37 100644
--- a/lib/system.nim
+++ b/lib/system.nim
@@ -2142,6 +2142,10 @@ proc delete*[T](x: var seq[T], i: Natural) {.noSideEffect, auditDelete.} =
   ##
   ## This is an `O(n)` operation.
   ##
+  ## .. note:: With `-d:nimStrictDelete`, an index error is produced when the index passed
+  ##    to it was out of bounds. `-d:nimStrictDelete` will become the default
+  ##    in upcoming versions.
+  ##
   ## See also:
   ## * `del <#del,seq[T],Natural>`_ for O(1) operation
   ##