changeset 1907:09c4fda8779d feature/grids/parameter_spaces

Fix some errors in docstrings
author Jonatan Werpers <jonatan@werpers.com>
date Sat, 01 Feb 2025 22:55:16 +0100
parents 447ea06bfa07
children dcbe8119fb0a
files src/Grids/parameter_space.jl
diffstat 1 files changed, 4 insertions(+), 5 deletions(-) [+]
line wrap: on
line diff
--- a/src/Grids/parameter_space.jl	Sat Feb 01 22:48:13 2025 +0100
+++ b/src/Grids/parameter_space.jl	Sat Feb 01 22:55:16 2025 +0100
@@ -12,9 +12,8 @@
 * [`unittetrahedron`](@ref)
 * [`unitsimplex`](@ref)
 
-See also: [`Interval`](@ref), [`Rectangle`](@ref), [`Box`](@ref),
-[`Triangle`](@ref), [`Tetrahedron`](@ref), [`HyperBox`](@ref),
-[`Simplex`](@ref),
+See also: [`Interval`](@ref), [`HyperBox`](@ref),
+[`Simplex`](@ref).
 """
 abstract type ParameterSpace{D} end
 Base.ndims(::ParameterSpace{D}) where D = D
@@ -152,7 +151,7 @@
 """
     unittriangle(T=Float64)
 
-The simplex with verticies ``(0,0)``, ``(1,0)``, and ``(0,1).
+The simplex with verticies ``(0,0)``, ``(1,0)``, and ``(0,1)``.
 """
 unittriangle(T=Float64) = unitsimplex(T,2)
 
@@ -166,7 +165,7 @@
 """
     unitsimplex(T=Float64,D)
 
-The unit simplex in dimension ``D`` with verticies ``(0,0,0,...)``, ``(1,0,0,...)``, ``(0,1,0,...)``, ``(0,0,1,...)``...
+The unit simplex in dimension `D` with verticies ``(0,0,0,...)``, ``(1,0,0,...)``, ``(0,1,0,...)``, ``(0,0,1,...)``...
 """
 function unitsimplex(T,D)
     z = @SVector zeros(T,D)