Mercurial > repos > public > sbplib_julia

changeset 1904:e54fed6a9ada feature/grids/parameter_spaces

Find changesets by keywords (author, files, the commit message), revision number or hash, or revset expression.
Improve documentation for ParameterSpace
author Jonatan Werpers <jonatan@werpers.com>
date Sat, 01 Feb 2025 22:24:56 +0100
parents f93ba5832146
children 238ef43fe92a
files src/Grids/parameter_space.jl
diffstat 1 files changed, 9 insertions(+), 10 deletions(-) [+]
line wrap: on
line diff
--- a/src/Grids/parameter_space.jl	Sat Feb 01 22:12:53 2025 +0100
+++ b/src/Grids/parameter_space.jl	Sat Feb 01 22:24:56 2025 +0100
@@ -1,17 +1,16 @@
 """
     ParameterSpace{D}
 
-A space of parameters of dimension `D`. Used with `Chart` to indicate which
-parameters are valid for that chart.
+A space of parameters of dimension `D`.
 
-Common parameter spaces are created using the functions unit sized spaces
-* `unitinterval`
-* `unitrectangle`
-* `unitbox`
-* `unittriangle`
-* `unittetrahedron`
-* `unithyperbox`
-* `unitsimplex`
+Common parameter spaces are created using functions for unit sized spaces
+* [`unitinterval`](@ref)
+* [`unitsquare`](@ref)
+* [`unitcube`](@ref)
+* [`unithyperbox`](@ref)
+* [`unittriangle`](@ref)
+* [`unittetrahedron`](@ref)
+* [`unitsimplex`](@ref)
 
 See also: [`Interval`](@ref), [`Rectangle`](@ref), [`Box`](@ref),
 [`Triangle`](@ref), [`Tetrahedron`](@ref), [`HyperBox`](@ref),