links in docs

RimuQMC · Jan 18, 2025 · e3058dd · e3058dd
1 parent c195317
commit e3058dd
Show file tree

Hide file tree

Showing 3 changed files with 7 additions and 6 deletions.
diff --git a/src/RimuIO/RimuIO.jl b/src/RimuIO/RimuIO.jl
@@ -77,7 +77,8 @@ end
 
 Save [`PDVec`](@ref) or [`DVec`](@ref) `vector` to an arrow file `filename`.
 
-`io` determines the output stream to write progress to. Defaults to `stderr` when MPI is enabled and `devnull` otherwise.
+`io` determines the output stream to write progress to. Defaults to `stderr` when MPI is
+enabled and `devnull` otherwise.
 
 All other `kwargs` are saved as strings to the arrow file and will be parsed back when the
 state is loaded.
@@ -136,8 +137,8 @@ end
     load_state(DVec, filename; kwargs...) -> DVec, NamedTuple
 
 Load the state saved in the Arrow file `filename`. `kwargs` are passed to the constructor of
-`PDVec`. Any metadata stored in the file is be parsed as a number (if possible) and returned
-alongside the vector in a `NamedTuple`.
+[`PDVec`](@ref)/[`DVec`](@ref). Any metadata stored in the file is be parsed as a number (if
+possible) and returned alongside the vector in a `NamedTuple`.
 
 See also [`save_state`](@ref).
 """

diff --git a/src/RimuIO/tables.jl b/src/RimuIO/tables.jl
@@ -1,7 +1,7 @@
 """
     struct DVecAsTable
 
-Wrapper over the storage of a `DVec` that allows us to treat a `DVec` as a
+Wrapper over the storage of a [`DVec`](@ref) that allows us to treat a [`DVec`](@ref) as a
 table from Tables.jl. Constructed with `Tables.table(::DVec)`.
 """
 struct DVecAsTable{K,V}
@@ -36,7 +36,7 @@ Tables.rows(tbl::DVecAsTable) = tbl
 """
     struct PDVecAsTable
 
-Wrapper over the storage of a `PDVec` that allows us to treat a `PDVec` as a
+Wrapper over the storage of a [`PDVec`](@ref) that allows us to treat a [`PDVec`](@ref) as a
 table from Tables.jl. Constructed with `Tables.table(::PDVec)`.
 """
 struct PDVecAsTable{K,V,N}

diff --git a/test/RimuIO.jl b/test/RimuIO.jl
@@ -82,8 +82,8 @@ end
     rm(file; force=true)
 
     @testset "vectors" begin
+        ham = HubbardReal1D(BoseFS(1,1,1))
         @testset "save DVec" begin
-            ham = HubbardReal1D(BoseFS(1,1,1))
             dvec = ham * DVec([BoseFS(1,1,1) => 1.0, BoseFS(2,1,0) => π])
             save_state(file, dvec)
             output, _ = load_state(file)