add docs

src/ising.jl

@@ -68,10 +68,32 @@ function ising_graph(
     ig
 end
 
+"""
+$(TYPEDSIGNATURES)
+
+Returns an Array with nodes of graph.
+"""
 nodes(ig::MetaGraph) = collect(get_prop.(Ref(ig), vertices(ig), :node))
+
+"""
+$(TYPEDSIGNATURES)
+
+Returns an Array with ranks of graph.
+"""
 rank_vec(ig::MetaGraph) = collect(values(get_prop(ig, :rank)))
+
+"""
+$(TYPEDSIGNATURES)
+
+Returns size of graph's basis.
+"""
 basis_size(ig::MetaGraph) = prod(prod(rank_vec(ig)))
 
+"""
+$(TYPEDSIGNATURES)
+
+Creates cluster of ising graph induced by vertices verts.
+"""
 function cluster(ig::MetaGraph, verts)
     sub_ig, vmap = induced_subgraph(ig, collect(verts))
 

src/lattice.jl

@@ -1,6 +1,11 @@
 export super_square_lattice
 
- function super_square_lattice(size::NTuple{5, Int})
+"""
+$(TYPEDSIGNATURES)
+
+Creates square lattice used eg. as an assignment rule.
+"""
+function super_square_lattice(size::NTuple{5, Int})
     m, um, n, un, t = size
     new = LinearIndices((1:n, 1:m))
     old = LinearIndices((1:t, 1:un, 1:n, 1:um, 1:m))
@@ -11,6 +16,12 @@ export super_square_lattice
     )
 end
 
+
+"""
+$(TYPEDSIGNATURES)
+
+Creates square lattice used eg. as an assignment rule.
+"""
 function super_square_lattice(size::NTuple{3, Int})
     m, n, t = size
     super_square_lattice((m, 1, n, 1, t))

src/spectrum.jl

@@ -62,6 +62,17 @@ function brute_force(ig::MetaGraph; sorted=true, num_states::Int=1)
     end
 end
 
+"""
+$(TYPEDSIGNATURES)
+
+Return the low energy spectrum
+
+# Details
+
+Calculates \$k\$ lowest energy states
+together with the coresponding energies
+of a classical Ising Hamiltonian
+"""
 full_spectrum(ig::MetaGraph; num_states::Int=1) = brute_force(ig, sorted=false, num_states=num_states)
 
 struct Spectrum