jyapayne/Nim
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity Actions

Document that system:pop() may raise IndexDefect (#21070)

Browse source 
* Document system:pop() may raise IndexDefect

* Add backticks to KeyError
This commit is contained in:
Xavier Noria 2022-12-13 08:47:01 +01:00 • committed by GitHub
commit e4aadcf1c1
No known key found for this signature in database
GPG key ID: 4AEE18F83AFDEB23
2 changed files with 5 additions and 3 deletions
Download patch file Download diff file Expand all files Collapse all files

6
lib/pure/collections/sets.nim
View file

@ -347,7 +347,7 @@ proc missingOrExcl*[A](s: var HashSet[A], key: A): bool =
proc pop*[A](s: var HashSet[A]): A = proc pop*[A](s: var HashSet[A]): A =
## Removes and returns an arbitrary element from the set `s`. ## Removes and returns an arbitrary element from the set `s`.
## ##
## Raises KeyError if the set `s` is empty. ## Raises `KeyError` if the set `s` is empty.
## ##
## See also: ## See also:
## * `clear proc <#clear,HashSet[A]>`_ ## * `clear proc <#clear,HashSet[A]>`_
@ -425,7 +425,7 @@ proc intersection*[A](s1, s2: HashSet[A]): HashSet[A] =
assert c == toHashSet(["b"]) assert c == toHashSet(["b"])
result = initHashSet[A](max(min(s1.data.len, s2.data.len), 2)) result = initHashSet[A](max(min(s1.data.len, s2.data.len), 2))
# iterate over the elements of the smaller set # iterate over the elements of the smaller set
if s1.data.len < s2.data.len: if s1.data.len < s2.data.len:
for item in s1: for item in s1:
@ -433,7 +433,7 @@ proc intersection*[A](s1, s2: HashSet[A]): HashSet[A] =
else: else:
for item in s2: for item in s2:
if item in s1: incl(result, item) if item in s1: incl(result, item)
proc difference*[A](s1, s2: HashSet[A]): HashSet[A] = proc difference*[A](s1, s2: HashSet[A]): HashSet[A] =
## Returns the difference of the sets `s1` and `s2`. ## Returns the difference of the sets `s1` and `s2`.

2
lib/system.nim
View file

@ -1664,6 +1664,8 @@ proc contains*[T](a: openArray[T], item: T): bool {.inline.}=
proc pop*[T](s: var seq[T]): T {.inline, noSideEffect.} = proc pop*[T](s: var seq[T]): T {.inline, noSideEffect.} =
## Returns the last item of `s` and decreases `s.len` by one. This treats ## Returns the last item of `s` and decreases `s.len` by one. This treats
## `s` as a stack and implements the common *pop* operation. ## `s` as a stack and implements the common *pop* operation.
##
## Raises `IndexDefect` if `s` is empty.
runnableExamples: runnableExamples:
var a = @[1, 3, 5, 7] var a = @[1, 3, 5, 7]
let b = pop(a) let b = pop(a)