Improve tables docs for del/take (#11030)
* Continuation of b40a637f
* https://forum.nim-lang.org/t/4789
This commit is contained in:
parent
7d8af25d58
commit
14fc7437c3
1 changed files with 5 additions and 1 deletions
|
|
@ -87,7 +87,7 @@
|
|||
## for pairs in zip(years, names):
|
||||
## let (birthYear, name) = pairs
|
||||
## if not beatlesByYear.hasKey(birthYear):
|
||||
## # if a key doesn't exists, we create one with an empty sequence
|
||||
## # if a key doesn't exist, we create one with an empty sequence
|
||||
## # before we can add elements to it
|
||||
## beatlesByYear[birthYear] = @[]
|
||||
## beatlesByYear[birthYear].add(name)
|
||||
|
|
@ -977,6 +977,8 @@ proc add*[A, B](t: TableRef[A, B], key: A, val: B) =
|
|||
proc del*[A, B](t: TableRef[A, B], key: A) =
|
||||
## Deletes ``key`` from hash table ``t``. Does nothing if the key does not exist.
|
||||
##
|
||||
## **If duplicate keys were added, this may need to be called multiple times.**
|
||||
##
|
||||
## See also:
|
||||
## * `take proc<#take,TableRef[A,B],A,B>`_
|
||||
## * `clear proc<#clear,TableRef[A,B]>`_ to empty the whole table
|
||||
|
|
@ -994,6 +996,8 @@ proc take*[A, B](t: TableRef[A, B], key: A, val: var B): bool =
|
|||
## mapping of the key. Otherwise, returns ``false``, and the ``val`` is
|
||||
## unchanged.
|
||||
##
|
||||
## **If duplicate keys were added, this may need to be called multiple times.**
|
||||
##
|
||||
## See also:
|
||||
## * `del proc<#del,TableRef[A,B],A>`_
|
||||
## * `clear proc<#clear,TableRef[A,B]>`_ to empty the whole table
|
||||
|
|
|
|||
Loading…
Add table
Add a link
Reference in a new issue