Switch to Documenter 1.x

fingolfin · fingolfin · commit 6682b5a32da1 · 2025-03-18T17:17:24.000+01:00
diff --git a/docs/Project.toml b/docs/Project.toml
@@ -2,4 +2,4 @@
 Documenter = "e30172f5-a6a5-5a46-863b-614d45cd2de4"
 
 [compat]
-Documenter = "0.23"
+Documenter = "1"
diff --git a/docs/make.jl b/docs/make.jl
@@ -5,6 +5,7 @@ DocMeta.setdocmeta!(DataStructures, :DocTestSetup, :(using DataStructures); recu
 
 makedocs(
     sitename = "DataStructures.jl",
+    warnonly = true,  # FIXME: address all warnings and resolve them
     pages = [
         "index.md",
         "deque.md",
diff --git a/docs/src/priority-queue.md b/docs/src/priority-queue.md
@@ -33,14 +33,14 @@ julia> # Julia code
 
 julia> # Insert keys with associated priorities
        pq["a"] = 10; pq["b"] = 5; pq["c"] = 15; pq
-PriorityQueue{Any,Any,Base.Order.ForwardOrdering} with 3 entries:
+PriorityQueue{Any, Any, Base.Order.ForwardOrdering} with 3 entries:
   "b" => 5
   "a" => 10
   "c" => 15
 
 julia> # Change the priority of an existing key
        pq["a"] = 0; pq
-PriorityQueue{Any,Any,Base.Order.ForwardOrdering} with 3 entries:
+PriorityQueue{Any, Any, Base.Order.ForwardOrdering} with 3 entries:
   "a" => 0
   "b" => 5
   "c" => 15
diff --git a/docs/src/robin_dict.md b/docs/src/robin_dict.md
@@ -13,14 +13,14 @@ Examples:
 
 ```jldoctest
 julia> d = RobinDict{Int, Char}(1 => 'a', 2 => 'b')
-RobinDict{Int64,Char} with 2 entries:
+RobinDict{Int64, Char} with 2 entries:
   2 => 'b'
   1 => 'a'
 
 julia> d[3] = 'c';
 
 julia> collect(d)
-3-element Array{Pair{Int64,Char},1}:
+3-element Vector{Pair{Int64, Char}}:
  2 => 'b'
  3 => 'c'
  1 => 'a'
@@ -31,7 +31,7 @@ julia> d[1]
 'a': ASCII/Unicode U+0061 (category Ll: Letter, lowercase)
 
 julia> d
-RobinDict{Int64,Char} with 2 entries:
+RobinDict{Int64, Char} with 2 entries:
   3 => 'c'
   1 => 'a'
 
diff --git a/docs/src/swiss_dict.md b/docs/src/swiss_dict.md
@@ -12,14 +12,14 @@ Examples:
 
 ```jldoctest
 julia> d = SwissDict(1 => 'a', 2 => 'b')
-SwissDict{Int64,Char} with 2 entries:
+SwissDict{Int64, Char} with 2 entries:
   1 => 'a'
   2 => 'b'
 
 julia> d[3] = 'c';
 
 julia> collect(d)
-3-element Array{Pair{Int64,Char},1}:
+3-element Vector{Pair{Int64, Char}}:
  1 => 'a'
  2 => 'b'
  3 => 'c'
@@ -30,7 +30,7 @@ julia> d[1]
 'a': ASCII/Unicode U+0061 (category Ll: Letter, lowercase)
 
 julia> d
-SwissDict{Int64,Char} with 2 entries:
+SwissDict{Int64, Char} with 2 entries:
   1 => 'a'
   3 => 'c'
 
diff --git a/src/heaps/arrays_as_heaps.jl b/src/heaps/arrays_as_heaps.jl
@@ -122,7 +122,7 @@ Return `true` if an array is heap-ordered according to the given order.
 
 ```jldoctest
 julia> a = [1,2,3]
-3-element Array{Int64,1}:
+3-element Vector{Int64}:
  1
  2
  3
diff --git a/src/ordered_robin_dict.jl b/src/ordered_robin_dict.jl
@@ -12,7 +12,7 @@ are taken from 2-tuples `(key,value)` generated by the argument.
 # Examples
 ```jldoctest
 julia> OrderedRobinDict([("A", 1), ("B", 2)])
-OrderedRobinDict{String,Int64} with 2 entries:
+OrderedRobinDict{String, Int64} with 2 entries:
   "A" => 1
   "B" => 2
 ```
@@ -21,7 +21,7 @@ Alternatively, a sequence of pair arguments may be passed.
 
 ```jldoctest
 julia> OrderedRobinDict("A"=>1, "B"=>2)
-OrderedRobinDict{String,Int64} with 2 entries:
+OrderedRobinDict{String, Int64} with 2 entries:
   "A" => 1
   "B" => 2
 ```
@@ -94,14 +94,14 @@ Remove all elements from a `collection`.
 # Examples
 ```jldoctest
 julia> A = OrderedRobinDict("a" => 1, "b" => 2)
-OrderedRobinDict{String,Int64} with 2 entries:
+OrderedRobinDict{String, Int64} with 2 entries:
   "a" => 1
   "b" => 2
 
 julia> empty!(A);
 
 julia> A
-OrderedRobinDict{String,Int64} with 0 entries
+OrderedRobinDict{String, Int64}()
 ```
 """
 function Base.empty!(h::OrderedRobinDict{K,V}) where {K, V}
@@ -198,7 +198,7 @@ julia> get!(d, "d", 4)
 4
 
 julia> d
-OrderedRobinDict{String,Int64} with 4 entries:
+OrderedRobinDict{String, Int64} with 4 entries:
   "a" => 1
   "b" => 2
   "c" => 3
@@ -291,7 +291,7 @@ Determine whether a collection has a mapping for a given `key`.
 # Examples
 ```jldoctest
 julia> D = OrderedRobinDict('a'=>2, 'b'=>3)
-OrderedRobinDict{Char,Int64} with 2 entries:
+OrderedRobinDict{Char, Int64} with 2 entries:
   'a' => 2
   'b' => 3
 
@@ -313,7 +313,7 @@ Return the key matching argument `key` if one exists in `collection`, otherwise
 # Examples
 ```jldoctest
 julia> D = OrderedRobinDict('a'=>2, 'b'=>3)
-OrderedRobinDict{Char,Int64} with 2 entries:
+OrderedRobinDict{Char, Int64} with 2 entries:
   'a' => 2
   'b' => 3
 
@@ -389,12 +389,12 @@ Delete the mapping for the given key in a collection, and return the collection.
 # Examples
 ```jldoctest
 julia> d = OrderedRobinDict("a"=>1, "b"=>2)
-OrderedRobinDict{String,Int64} with 2 entries:
+OrderedRobinDict{String, Int64} with 2 entries:
   "a" => 1
   "b" => 2
 
 julia> delete!(d, "b")
-OrderedRobinDict{String,Int64} with 1 entry:
+OrderedRobinDict{String, Int64} with 1 entry:
   "a" => 1
 ```
 """
diff --git a/src/priorityqueue.jl b/src/priorityqueue.jl
@@ -17,7 +17,7 @@ lowest priority element.
 
 ```jldoctest
 julia> PriorityQueue(Base.Order.Forward, "a" => 2, "b" => 3, "c" => 1)
-PriorityQueue{String,Int64,Base.Order.ForwardOrdering} with 3 entries:
+PriorityQueue{String, Int64, Base.Order.ForwardOrdering} with 3 entries:
   "c" => 1
   "a" => 2
   "b" => 3
@@ -212,13 +212,13 @@ Insert the a key `k` into a priority queue `pq` with priority `v`.
 
 ```jldoctest
 julia> a = PriorityQueue(PriorityQueue("a"=>1, "b"=>2, "c"=>3))
-PriorityQueue{String,Int64,Base.Order.ForwardOrdering} with 3 entries:
+PriorityQueue{String, Int64, Base.Order.ForwardOrdering} with 3 entries:
   "a" => 1
   "b" => 2
   "c" => 3
 
 julia> enqueue!(a, "d"=>4)
-PriorityQueue{String,Int64,Base.Order.ForwardOrdering} with 4 entries:
+PriorityQueue{String, Int64, Base.Order.ForwardOrdering} with 4 entries:
   "a" => 1
   "b" => 2
   "c" => 3
@@ -253,7 +253,7 @@ Remove and return the lowest priority key from a priority queue.
 
 ```jldoctest
 julia> a = PriorityQueue(Base.Order.Forward, ["a" => 2, "b" => 3, "c" => 1])
-PriorityQueue{String,Int64,Base.Order.ForwardOrdering} with 3 entries:
+PriorityQueue{String, Int64, Base.Order.ForwardOrdering} with 3 entries:
   "c" => 1
   "a" => 2
   "b" => 3
@@ -262,7 +262,7 @@ julia> dequeue!(a)
 "c"
 
 julia> a
-PriorityQueue{String,Int64,Base.Order.ForwardOrdering} with 2 entries:
+PriorityQueue{String, Int64, Base.Order.ForwardOrdering} with 2 entries:
   "a" => 2
   "b" => 3
 ```
@@ -293,7 +293,7 @@ Remove and return a the lowest priority key and value from a priority queue as a
 
 ```jldoctest
 julia> a = PriorityQueue(Base.Order.Forward, "a" => 2, "b" => 3, "c" => 1)
-PriorityQueue{String,Int64,Base.Order.ForwardOrdering} with 3 entries:
+PriorityQueue{String, Int64, Base.Order.ForwardOrdering} with 3 entries:
   "c" => 1
   "a" => 2
   "b" => 3
@@ -302,7 +302,7 @@ julia> dequeue_pair!(a)
 "c" => 1
 
 julia> a
-PriorityQueue{String,Int64,Base.Order.ForwardOrdering} with 2 entries:
+PriorityQueue{String, Int64, Base.Order.ForwardOrdering} with 2 entries:
   "a" => 2
   "b" => 3
 ```
@@ -332,7 +332,7 @@ Delete the mapping for the given key in a priority queue, and return the priorit
 # Examples
 ```jldoctest
 julia> q = PriorityQueue(Base.Order.Forward, "a"=>2, "b"=>3, "c"=>1)
-PriorityQueue{String,Int64,Base.Order.ForwardOrdering} with 3 entries:
+PriorityQueue{String, Int64, Base.Order.ForwardOrdering} with 3 entries:
   "c" => 1
   "a" => 2
   "b" => 3
diff --git a/src/robin_dict.jl b/src/robin_dict.jl
@@ -12,7 +12,7 @@ are taken from 2-tuples `(key,value)` generated by the argument.
 # Examples
 ```jldoctest
 julia> RobinDict([("A", 1), ("B", 2)])
-RobinDict{String,Int64} with 2 entries:
+RobinDict{String, Int64} with 2 entries:
   "B" => 2
   "A" => 1
 ```
@@ -21,7 +21,7 @@ Alternatively, a sequence of pair arguments may be passed.
 
 ```jldoctest
 julia> RobinDict("A"=>1, "B"=>2)
-RobinDict{String,Int64} with 2 entries:
+RobinDict{String, Int64} with 2 entries:
   "B" => 2
   "A" => 1
 ```
@@ -259,14 +259,14 @@ Remove all elements from a `collection`.
 # Examples
 ```jldoctest
 julia> A = RobinDict("a" => 1, "b" => 2)
-RobinDict{String,Int64} with 2 entries:
+RobinDict{String, Int64} with 2 entries:
   "b" => 2
   "a" => 1
 
 julia> empty!(A);
 
 julia> A
-RobinDict{String,Int64} with 0 entries
+RobinDict{String, Int64}()
 ```
 """
 function Base.empty!(h::RobinDict{K,V}) where {K, V}
@@ -317,7 +317,7 @@ julia> get!(d, "d", 4)
 4
 
 julia> d
-RobinDict{String,Int64} with 4 entries:
+RobinDict{String, Int64} with 4 entries:
   "c" => 3
   "b" => 2
   "a" => 1
@@ -414,7 +414,7 @@ Determine whether a collection has a mapping for a given `key`.
 # Examples
 ```jldoctest
 julia> D = RobinDict('a'=>2, 'b'=>3)
-RobinDict{Char,Int64} with 2 entries:
+RobinDict{Char, Int64} with 2 entries:
   'a' => 2
   'b' => 3
 
@@ -436,7 +436,7 @@ Return the key matching argument `key` if one exists in `collection`, otherwise
 # Examples
 ```jldoctest
 julia> D = RobinDict('a'=>2, 'b'=>3)
-RobinDict{Char,Int64} with 2 entries:
+RobinDict{Char, Int64} with 2 entries:
   'a' => 2
   'b' => 3
 
@@ -547,12 +547,12 @@ Delete the mapping for the given key in a collection, and return the collection.
 # Examples
 ```jldoctest
 julia> d = RobinDict("a"=>1, "b"=>2)
-RobinDict{String,Int64} with 2 entries:
+RobinDict{String, Int64} with 2 entries:
   "b" => 2
   "a" => 1
 
 julia> delete!(d, "b")
-RobinDict{String,Int64} with 1 entry:
+RobinDict{String, Int64} with 1 entry:
   "a" => 1
 ```
 """
diff --git a/src/swiss_dict.jl b/src/swiss_dict.jl

Original file line number	Diff line number	Diff line change
@@ -122,7 +122,7 @@ Return `true` if an array is heap-ordered according to the given order.
`122`	`122`
`123`	`123`	```jldoctest
`124`	`124`	`julia> a = [1,2,3]`
`125`		`-3-element Array{Int64,1}:`
	`125`	`+3-element Vector{Int64}:`
`126`	`126`	`1`
`127`	`127`	`2`
`128`	`128`	`3`