From 81900752ef0f5d0f756034c725042461ce8bc474 Mon Sep 17 00:00:00 2001 From: David Little Date: Wed, 3 Apr 2024 10:40:14 -0400 Subject: [PATCH] cleanup up doc generation --- docs/.gitignore | 1 + docs/Project.toml | 1 + src/WeakKeyIdDicts.jl | 15 ++++++++------- 3 files changed, 10 insertions(+), 7 deletions(-) create mode 100644 docs/.gitignore diff --git a/docs/.gitignore b/docs/.gitignore new file mode 100644 index 0000000..a007fea --- /dev/null +++ b/docs/.gitignore @@ -0,0 +1 @@ +build/* diff --git a/docs/Project.toml b/docs/Project.toml index 1814eb3..3243236 100644 --- a/docs/Project.toml +++ b/docs/Project.toml @@ -1,5 +1,6 @@ [deps] Documenter = "e30172f5-a6a5-5a46-863b-614d45cd2de4" +WeakKeyIdDicts = "ecbed89c-9d59-4137-ae1f-d1084086d01c" [compat] Documenter = "1" diff --git a/src/WeakKeyIdDicts.jl b/src/WeakKeyIdDicts.jl index 1573d59..03e162a 100644 --- a/src/WeakKeyIdDicts.jl +++ b/src/WeakKeyIdDicts.jl @@ -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}