diff --git a/docs/src/api.md b/docs/src/api.md index afc21ca25e1..7f1eb46ccd2 100644 --- a/docs/src/api.md +++ b/docs/src/api.md @@ -6,7 +6,7 @@ ClimaAtmos.TurbulenceConvection.Parameters ## Initial conditions -### General +### General ```@docs ClimaAtmos.InitialConditions.InitialCondition diff --git a/docs/src/parameters.md b/docs/src/parameters.md index 3fc3b942995..506412f85e3 100644 --- a/docs/src/parameters.md +++ b/docs/src/parameters.md @@ -18,7 +18,7 @@ alias = "grav" value = 9.81 type = "float" ``` -For more info on formatting the TOML, see [here]([https://clima.github.io/CLIMAParameters.jl/dev/toml/](https://clima.github.io/CLIMAParameters.jl/dev/toml/)). +For more info on formatting the TOML, see [here](https://clima.github.io/CLIMAParameters.jl/dev/toml/). # After CLI Removal: @@ -38,5 +38,5 @@ From the command-line at the top-level CA directory, just run `julia --project=e If running the model interactively, you can change `ARGS` and append `["--toml", "path/to/toml"]`. Alternatively, you can create the `parsed_args` dictionary and manually alter it yourself: `parsed_args["toml"] = "path/to/toml"`. -If you are just overriding a parameter, you can just create the model config and run the model! -If you add a new parameter, you need to alter the [ClimaAtmosParameters]([https://github.com/CliMA/ClimaAtmos.jl/blob/main/src/parameters/Parameters.jl](https://github.com/CliMA/ClimaAtmos.jl/blob/main/src/parameters/Parameters.jl#L13)) struct to include your parameter. This can temporarily be done at the top level if you need to test something quickly, but if you want to merge the code, it is best to place your new parameter inside one of the nested parameter structs. +If you are just overriding a parameter, you can just create the model config and run the model! +If you add a new parameter, you need to alter the [ClimaAtmosParameters](https://github.com/CliMA/ClimaAtmos.jl/blob/main/src/parameters/Parameters.jl#L13) struct to include your parameter. This can temporarily be done at the top level if you need to test something quickly, but if you want to merge the code, it is best to place your new parameter inside one of the nested parameter structs. diff --git a/src/initial_conditions/initial_conditions.jl b/src/initial_conditions/initial_conditions.jl index fa0bca18fa0..8b9300e35d6 100644 --- a/src/initial_conditions/initial_conditions.jl +++ b/src/initial_conditions/initial_conditions.jl @@ -561,7 +561,7 @@ end """ GABLS -The `InitialCondition` described in [Kosovic2000](cite), but with a hydrostatically +The `InitialCondition` described in [Kosovic2000](@cite), but with a hydrostatically balanced pressure profile. """ Base.@kwdef struct GABLS <: InitialCondition @@ -777,7 +777,7 @@ end """ Rico -The `InitialCondition` described in [Rauber2007](cite), but with a hydrostatically +The `InitialCondition` described in [Rauber2007](@cite), but with a hydrostatically balanced pressure profile. """ Base.@kwdef struct Rico <: InitialCondition