Minor docs fixes

SunnySuite · Jul 19, 2023 · 3c24157 · 3c24157
1 parent 157d2a1
commit 3c24157
Show file tree

Hide file tree

Showing 3 changed files with 7 additions and 4 deletions.
diff --git a/src/Intensities/Binning.jl b/src/Intensities/Binning.jl
@@ -147,6 +147,8 @@ The second argument may be a 3x3 matrix specifying the reciprocal lattice vector
 - [`StructureFactor`](@ref)
 - [`SpinWaveTheory`](@ref)
 """
+bin_absolute_units_as_rlu!, bin_rlu_as_absolute_units!
+
 function bin_rlu_as_absolute_units!(params::BinningParameters,recip_vecs::AbstractMatrix)
     covectorsK = params.covectors
 
@@ -354,7 +356,7 @@ connected_path_bins(sw::SpinWaveTheory, ωvals, qs::Vector, density,args...;kwar
     intensity, counts = intensities_binned(sf::StructureFactor, params::BinningParameters; formula, integrated_kernel)
 
 Given correlation data contained in a [`StructureFactor`](@ref) and [`BinningParameters`](@ref) describing the
-shape of a histogram, compute the intensity and normalization for each histogram bin using a given [`intensity_fomula`](@ref), or `intensity_formula(sf,:perp)` by default.
+shape of a histogram, compute the intensity and normalization for each histogram bin using a given [`intensity_formula`](@ref), or `intensity_formula(sf,:perp)` by default.
 
 The [`BinningParameters`](@ref) are expected to accept `(k,ω)` in absolute units.
 

diff --git a/src/Intensities/ExperimentData.jl b/src/Intensities/ExperimentData.jl
@@ -2,7 +2,8 @@
     generate_mantid_script_from_binning_parameters(params::BinningParameters)
 
 Generate a Mantid script which bins data according to the 
-given [`BinningParameters`](@ref). You may want to call [`rlu_to_absolute_units!`](@ref) first.
+given [`BinningParameters`](@ref). Take care to ensure the units are correct (R.L.U. or absolute).
+You may want to call [`bin_rlu_as_absolute_units!`](@ref) or [`bin_absolute_units_as_rlu!`](@ref) first.
 """
 function generate_mantid_script_from_binning_parameters(params)
     covectorsK = params.covectors # Please call rlu_to_absolute_units! first if needed

diff --git a/src/StructureFactors/FormFactor.jl b/src/StructureFactors/FormFactor.jl
@@ -14,7 +14,7 @@ end
 
 Basic type for specifying form factor parameters. Must be provided a site within
 the unit cell (`atom`) and a string specifying the element name. This used when
-calling [`intensities`](@ref), which requires a list of `FormFactors`s.
+creating an [`intensity_formula`](@ref), which accepts a list of `FormFactors`s.
 
 A list of supported element names is available at:
 
@@ -155,4 +155,4 @@ end
 
 function compute_form(::Float64, ::FormFactor{EMPTY_FF})
     return 1.0
-end
+end