Fix tests and docstrings

src/Hamiltonians/geometry.jl

@@ -46,16 +46,36 @@ struct Geometry{D,Dims,Fold}
 end
 Geometry(args::Vararg{Int}) = Geometry(args)
 
+"""
+    PeriodicBoundaries(dims...) -> Geometry
+    PeriodicBoundaries(dims) -> Geometry
+
+Return `Geometry` with all dimensions periodic. Equivalent to `Geometry(dims)`.
+"""
 function PeriodicBoundaries(dims::NTuple{D,Int}) where {D}
     return Geometry(dims, ntuple(Returns(true), Val(D)))
 end
 PeriodicBoundaries(dims::Vararg{Int}) = PeriodicBoundaries(dims)
 
+"""
+    HardwallBoundaries(dims...) -> Geometry
+    HardwallBoundaries(dims) -> Geometry
+
+Return `Geometry` with all dimensions non-periodic. Equivalent to
+`Geometry(dims, (false, false, ...))`.
+"""
 function HardwallBoundaries(dims::NTuple{D,Int}) where {D}
     return Geometry(dims, ntuple(Returns(false), Val(D)))
 end
 HardwallBoundaries(dims::Vararg{Int}) = HardwallBoundaries(dims)
 
+"""
+    LadderBoundaries(dims...) -> Geometry
+    LadderBoundaries(dims) -> Geometry
+
+Return `Geometry` where the first dimension is dimensions non-periodic and the rest are
+periodic. Equivalent to `Geometry(dims, (true, false, ...))`.
+"""
 function LadderBoundaries(dims::NTuple{D,Int}) where {D}
     return Geometry(dims, ntuple(>(1), Val(D)))
 end

test/Hamiltonians.jl

@@ -867,9 +867,9 @@ using Rimu.Hamiltonians: circshift_dot
     @testset "G2RealSpace" begin
         @testset "1D G2RealCorrelator comparison" begin
             @testset "constructors" begin
-                g2_1 = G2RealSpace(Geometry(2, 2, 3), 1, 3) isa G2RealSpace{1,3}
-                g2_2 = G2RealSpace(Geometry(2, 2), 2) isa G2RealSpace{2,2}
-                g2_3 = G2RealSpace(Geometry(2, 2); sum_components=true) isa G2RealSpace{0,0}
+                g2_1 = G2RealSpace(Geometry(2, 2, 3), 1, 3)
+                g2_2 = G2RealSpace(Geometry(2, 2), 2)
+                g2_3 = G2RealSpace(Geometry(2, 2); sum_components=true)
                 @test g2_1 isa G2RealSpace{1,3}
                 @test g2_2 isa G2RealSpace{2,2}
                 @test g2_3 isa G2RealSpace{0,0}