From 534306e2dd7734f78c8c009de6742271826c91da Mon Sep 17 00:00:00 2001 From: Pablo San-Jose Date: Fri, 25 Oct 2024 20:25:42 +0200 Subject: [PATCH] docstring fix docstring fixes fix fix --- src/docstrings.jl | 25 ++++++++++++++++++------- 1 file changed, 18 insertions(+), 7 deletions(-) diff --git a/src/docstrings.jl b/src/docstrings.jl index f7749742..00f92f9f 100644 --- a/src/docstrings.jl +++ b/src/docstrings.jl @@ -2602,12 +2602,6 @@ interaction potentials, and `ρ` is the density matrix evaluated at specific che potential and temperature. Also `ν = ifelse(nambu, 0.5, 1.0)`, and `v_F(0) = v_H(0) = U`, where `U` is the onsite interaction. - zerofield - -An sigleton of type `ZeroField` that represents a zero-values field. It has the property -that it returns zero no matter how it is indexed (`zerofield[inds...] = 0.0 * I`), so it is -useful as a default value in a non-spatial model involving mean fields. - ## Keywords - `potential`: charge-charge potential to use for both Hartree and Fock. Can be a number or a function of position. Default: `1 @@ -2631,7 +2625,7 @@ e.g. `ϕ[sites(2:3), sites(1)]`, see `OrbitalSliceArray` for details. # Examples ```jldoctest -julia> model = hopping(I) - @onsite((i; phi = zerofield) --> phi[i]); +julia> model = hopping(I) - @onsite((i; phi = zerofield) --> phi[i]); # see zerofield docstring julia> g = LP.honeycomb() |> hamiltonian(model, orbitals = 2) |> supercell((1,-1)) |> greenfunction; @@ -2660,5 +2654,22 @@ julia> phi1[sites(1), sites(2)] |> Quantica.chopsmall 0.00307712+0.0im ⋅ ⋅ 0.00307712+0.0im ``` + +# See also + `zerofield`, `densitymatrix`, `OrbitalSliceMatrix` """ meanfield + +""" + zerofield + +An sigleton of type `ZeroField` that represents a zero-valued field. It has the property +that it returns zero no matter how it is indexed (`zerofield[inds...] = 0.0 * I`), so it is +useful as a default value in a non-spatial model involving mean fields. See `meanfield` for +a usage example. + +# See also + `meanfield` + +""" +zerofield