Skip to content

Commit

Permalink
docstring fix
Browse files Browse the repository at this point in the history
docstring fixes
  • Loading branch information
pablosanjose committed Oct 25, 2024
1 parent 0c48365 commit a5b4426
Showing 1 changed file with 15 additions and 7 deletions.
22 changes: 15 additions & 7 deletions src/docstrings.jl
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand All @@ -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;
Expand Down Expand Up @@ -2660,5 +2654,19 @@ 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-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. See `meanfield` for
a usage example.
"""
zerofield

0 comments on commit a5b4426

Please sign in to comment.