Skip to content

Commit

Permalink
Clean up warnings in docs
Browse files Browse the repository at this point in the history
  • Loading branch information
Sbozzolo committed Sep 6, 2023
1 parent e518ca2 commit 286a372
Show file tree
Hide file tree
Showing 3 changed files with 6 additions and 6 deletions.
2 changes: 1 addition & 1 deletion docs/src/api.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@ ClimaAtmos.TurbulenceConvection.Parameters

## Initial conditions

### General
### General

```@docs
ClimaAtmos.InitialConditions.InitialCondition
Expand Down
6 changes: 3 additions & 3 deletions docs/src/parameters.md
Original file line number Diff line number Diff line change
Expand Up @@ -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:
Expand All @@ -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.
4 changes: 2 additions & 2 deletions src/initial_conditions/initial_conditions.jl
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down Expand Up @@ -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
Expand Down

0 comments on commit 286a372

Please sign in to comment.