Skip to content

Commit

Permalink
Minor fix of docs of load_domain
Browse files Browse the repository at this point in the history
The function load_domain always need to have as input the path to the
domain file. Most of the uses of load_domain have inside the parenthesis
"path to domain data package". To keep consistency, this commit adds
this text to two calls of the functions that did not had an input.
  • Loading branch information
vitorhirata committed Feb 20, 2025
1 parent 9e611ab commit 99afe15
Showing 1 changed file with 2 additions and 2 deletions.
4 changes: 2 additions & 2 deletions docs/src/usage/scenario_generation.md
Original file line number Diff line number Diff line change
Expand Up @@ -90,7 +90,7 @@ those factors as constants. These then get ignored for the purpose of scenario
generation.

```julia
dom = ADRIA.load_domain()
dom = ADRIA.load_domain("path to domain data package")

# Could keep a copy of the original model parameters/bounds
# to reset to later.
Expand Down Expand Up @@ -123,7 +123,7 @@ Samples can also be taken over a constrained range. For example, if one wanted t
scenarios with high fogging and seeding, the following could be used:

```julia
dom = ADRIA.load_domain()
dom = ADRIA.load_domain("path to domain data package")

# Adjust seeding bounds. Note only lower and upper bounds are needed because the factors in
# question have a uniform distribution.
Expand Down

0 comments on commit 99afe15

Please sign in to comment.