Skip to content

Commit

Permalink
cleanup up doc generation
Browse files Browse the repository at this point in the history
  • Loading branch information
haberdashPI committed Apr 3, 2024
1 parent b2dd98a commit 8190075
Show file tree
Hide file tree
Showing 3 changed files with 10 additions and 7 deletions.
1 change: 1 addition & 0 deletions docs/.gitignore
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
build/*
1 change: 1 addition & 0 deletions docs/Project.toml
Original file line number Diff line number Diff line change
@@ -1,5 +1,6 @@
[deps]
Documenter = "e30172f5-a6a5-5a46-863b-614d45cd2de4"
WeakKeyIdDicts = "ecbed89c-9d59-4137-ae1f-d1084086d01c"

[compat]
Documenter = "1"
15 changes: 8 additions & 7 deletions src/WeakKeyIdDicts.jl
Original file line number Diff line number Diff line change
Expand Up @@ -33,15 +33,16 @@ Base.hash(wr::WeakRefForWeakDict, h::UInt) = Base.hash_uint(3h - objectid(wr.w.v
"""
WeakKeyIdDict([itr])
`WeakKeyIdDict()` constructs a hash table where the keys are weak
references to objects which may be garbage collected even when
referenced in a hash table.
`WeakKeyIdDict()` constructs a hash table where the keys are weak references to objects
which may be garbage collected even when referenced in a hash table.
See [`Dict`](@ref) for further help. Note, unlike [`Dict`](@ref),
`WeakKeyIdDict` does not convert keys on insertion, as this would imply the key
object was unreferenced anywhere before insertion.
See [`Dict`](https://docs.julialang.org/en/v1/base/collections/#Base.Dict) for further help.
Note, unlike [`Dict`](https://docs.julialang.org/en/v1/base/collections/#Base.Dict),
`WeakKeyIdDict` does not convert keys on insertion, as this would imply the key object was
unreferenced anywhere before insertion.
See also [`WeakRef`](@ref), [`WeakKeyDict`](@ref).
See also [`WeakRef`](https://docs.julialang.org/en/v1/base/base/#Core.WeakRef),
[`WeakKeyDict`](https://docs.julialang.org/en/v1/base/collections/#Base.WeakKeyDict).
"""
mutable struct WeakKeyIdDict{K,V} <: AbstractDict{K,V}
ht::Dict{WeakRefForWeakDict,V}
Expand Down

0 comments on commit 8190075

Please sign in to comment.