More doc improvements

CliMA · Nov 4, 2024 · 494548d · 494548d
1 parent 2c0f716
commit 494548d
Showing 1 changed file with 21 additions and 21 deletions.
diff --git a/src/Grids/CommonGrids.jl b/src/Grids/CommonGrids.jl
@@ -222,11 +222,11 @@ A convenience constructor, which builds an
  - `radius` the radius of the cubed sphere
  - `h_elem` the number of horizontal elements per side of every panel (6 panels in total)
  - `n_quad_points` the number of quadrature points per horizontal element
- - `device` the [`ClimaComms.device`](@ref)
- - `context` the [`ClimaComms.context`](@ref)
- - `stretch` the mesh [`Meshes.StretchingRule`](@ref) (defaults to `Uniform`)
- - `hypsography` the hypsography model. Can be one of [`Flat` (default), `LinearAdaption`, `SLEVEAdaption`].
- - `global_geometry` the global geometry (defaults to `Geometry.CartesianGlobalGeometry`)
+ - `device` the `ClimaComms.device`
+ - `context` the `ClimaComms.context`
+ - `stretch` the mesh `Meshes.StretchingRule` (defaults to [`Meshes.Uniform`](@ref))
+ - `hypsography` the hypsography model. Can be one of [[`Flat`](@ref) (default), [`Hypsography.LinearAdaption`](@ref), [`Hypsography.SLEVEAdaption`](@ref)].
+ - `global_geometry` the global geometry (defaults to [`Geometry.CartesianGlobalGeometry`](@ref))
  - `quad` the quadrature style (defaults to `Quadratures.GLL{n_quad_points}`)
  - `h_mesh` the horizontal mesh (defaults to `Meshes.EquiangularCubedSphere`)
  - `h_topology` the horizontal topology (defaults to `Topologies.Topology2D`)
@@ -326,8 +326,8 @@ A convenience constructor, which builds a
  - `radius` the radius of the cubed sphere
  - `h_elem` the number of horizontal elements per side of every panel (6 panels in total)
  - `n_quad_points` the number of quadrature points per horizontal element
- - `device` the [`ClimaComms.device`](@ref)
- - `context` the [`ClimaComms.context`](@ref)
+ - `device` the `ClimaComms.device`
+ - `context` the `ClimaComms.context`
  - `quad` the quadrature style (defaults to `Quadratures.GLL{n_quad_points}`)
  - `h_mesh` the horizontal mesh (defaults to `Meshes.EquiangularCubedSphere`)
  - `h_topology` the horizontal topology (defaults to `Topologies.Topology2D`)
@@ -445,11 +445,11 @@ A convenience constructor, which builds a
  - `n_quad_points` the number of quadrature points per horizontal element
  - `x_elem` the number of x-points
  - `y_elem` the number of y-points
- - `device` the [`ClimaComms.device`](@ref)
- - `context` the [`ClimaComms.context`](@ref)
- - `stretch` the mesh [`Meshes.StretchingRule`](@ref) (defaults to `Uniform`)
- - `hypsography` the hypsography model. Can be one of [`Flat` (default), `LinearAdaption`, `SLEVEAdaption`].
- - `global_geometry` the global geometry (defaults to `Geometry.CartesianGlobalGeometry`)
+ - `device` the `ClimaComms.device`
+ - `context` the `ClimaComms.context`
+ - `stretch` the mesh `Meshes.StretchingRule` (defaults to [`Meshes.Uniform`](@ref))
+ - `hypsography` the hypsography model. Can be one of [[`Flat`](@ref) (default), [`Hypsography.LinearAdaption`](@ref), [`Hypsography.SLEVEAdaption`](@ref)].
+ - `global_geometry` the global geometry (defaults to [`Geometry.CartesianGlobalGeometry`](@ref))
  - `quad` the quadrature style (defaults to `Quadratures.GLL{n_quad_points}`)
  - `h_topology` the horizontal topology (defaults to `Topologies.Topology2D`)
  - `z_mesh` the vertical mesh, defaults to an `Meshes.IntervalMesh` along `z` with given `stretch`
@@ -573,11 +573,11 @@ A convenience constructor, which builds a
  - `periodic_x` Bool indicating to use periodic domain along x-direction
  - `n_quad_points` the number of quadrature points per horizontal element
  - `x_elem` the number of x-points
- - `device` the [`ClimaComms.device`](@ref)
- - `context` the [`ClimaComms.context`](@ref)
- - `stretch` the mesh [`Meshes.StretchingRule`](@ref) (defaults to `Uniform`)
- - `hypsography` the hypsography model. Can be one of [`Flat` (default), `LinearAdaption`, `SLEVEAdaption`].
- - `global_geometry` the global geometry (defaults to `Geometry.CartesianGlobalGeometry`)
+ - `device` the `ClimaComms.device`
+ - `context` the `ClimaComms.context`
+ - `stretch` the mesh `Meshes.StretchingRule` (defaults to [`Meshes.Uniform`](@ref))
+ - `hypsography` the hypsography model. Can be one of [[`Flat`](@ref) (default), [`Hypsography.LinearAdaption`](@ref), [`Hypsography.SLEVEAdaption`](@ref)].
+ - `global_geometry` the global geometry (defaults to [`Geometry.CartesianGlobalGeometry`](@ref))
  - `quad` the quadrature style (defaults to `Quadratures.GLL{n_quad_points}`)
 
 # Example usage
@@ -677,10 +677,10 @@ A convenience constructor, which builds a
  - `n_quad_points` the number of quadrature points per horizontal element
  - `x_elem` the number of x-points
  - `y_elem` the number of y-points
- - `device` the [`ClimaComms.device`](@ref)
- - `context` the [`ClimaComms.context`](@ref)
- - `hypsography` the hypsography model. Can be one of [`Flat` (default), `LinearAdaption`, `SLEVEAdaption`].
- - `global_geometry` the global geometry (defaults to `Geometry.CartesianGlobalGeometry`)
+ - `device` the `ClimaComms.device`
+ - `context` the `ClimaComms.context`
+ - `hypsography` the hypsography model. Can be one of [[`Flat`](@ref) (default), [`Hypsography.LinearAdaption`](@ref), [`Hypsography.SLEVEAdaption`](@ref)].
+ - `global_geometry` the global geometry (defaults to [`Geometry.CartesianGlobalGeometry`](@ref))
  - `quad` the quadrature style (defaults to `Quadratures.GLL{n_quad_points}`)
 
 # Example usage