diff options
author | Yuriy Glukhov <yglukhov@users.noreply.github.com> | 2018-06-27 23:25:22 +0300 |
---|---|---|
committer | Andreas Rumpf <rumpf_a@web.de> | 2018-06-27 22:25:22 +0200 |
commit | e66b7f3909eda325c6629b374cba2627a007b510 (patch) | |
tree | aa9764d1d9187201b9d2e21e75584c954d1ed830 | |
parent | 9ed671b2fe734d6294c1aadc1b495215a3e926db (diff) | |
download | Nim-e66b7f3909eda325c6629b374cba2627a007b510.tar.gz |
Clarify the docs for tables.del (#8134)
-rw-r--r-- | lib/pure/collections/tables.nim | 10 |
1 files changed, 6 insertions, 4 deletions
diff --git a/lib/pure/collections/tables.nim b/lib/pure/collections/tables.nim index 7b508b294..308f31eae 100644 --- a/lib/pure/collections/tables.nim +++ b/lib/pure/collections/tables.nim @@ -280,7 +280,7 @@ iterator mvalues*[A, B](t: var Table[A, B]): var B = if isFilled(t.data[h].hcode): yield t.data[h].val proc del*[A, B](t: var Table[A, B], key: A) = - ## deletes `key` from hash table `t`. + ## deletes `key` from hash table `t`. Does nothing if the key does not exist. delImpl() proc take*[A, B](t: var Table[A, B], key: A, val: var B): bool = @@ -457,7 +457,7 @@ proc add*[A, B](t: TableRef[A, B], key: A, val: B) = t[].add(key, val) proc del*[A, B](t: TableRef[A, B], key: A) = - ## deletes `key` from hash table `t`. + ## deletes `key` from hash table `t`. Does nothing if the key does not exist. t[].del(key) proc take*[A, B](t: TableRef[A, B], key: A, val: var B): bool = @@ -845,7 +845,8 @@ proc sort*[A, B](t: OrderedTableRef[A, B], cmp: proc (x,y: (A, B)): int) = t[].sort(cmp) proc del*[A, B](t: var OrderedTable[A, B], key: A) = - ## deletes `key` from ordered hash table `t`. O(n) complexity. + ## deletes `key` from ordered hash table `t`. O(n) complexity. Does nothing + ## if the key does not exist. var n: OrderedKeyValuePairSeq[A, B] newSeq(n, len(t.data)) var h = t.first @@ -864,7 +865,8 @@ proc del*[A, B](t: var OrderedTable[A, B], key: A) = h = nxt proc del*[A, B](t: var OrderedTableRef[A, B], key: A) = - ## deletes `key` from ordered hash table `t`. O(n) complexity. + ## deletes `key` from ordered hash table `t`. O(n) complexity. Does nothing + ## if the key does not exist. t[].del(key) # ------------------------------ count tables ------------------------------- |