Skip to content

Commit cb6ca79

Browse files
committed
Adjust docs.
1 parent 9e1fb4d commit cb6ca79

1 file changed

Lines changed: 2 additions & 2 deletions

File tree

src/main/apply_geography.jl

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -11,7 +11,7 @@ and similarly for graph traversal costs `delta_tau`.
1111
1212
# Arguments
1313
- `graph`: Dict or NamedTuple that contains the network graph to which the geographical features will be applied.
14-
- `geography::NamedTuple`: A named tuple representing the geographical features, with the following fields:\n
14+
- `geography`: Dict or NamedTuple representing the geographical features, with the following fields:\n
1515
- `z::Vector{Float64}`: A J x 1 vector containing the z-coordinate (elevation) for each node, or `nothing` if no elevation data.\n
1616
- `z_is_friction::Bool`: (Optional) logical value indicate that `z` represents friction rather than elevation. In that case, the measure of building cost is the average friction of the two nodes mean(Z1,Z2) rather than the difference Z2-Z1.\n
1717
- `obstacles::Matrix{Int64}`: An Nobs x 2 matrix specifying (i, j) pairs of nodes that are connected by obstacles, where Nobs is the number of obstacles, or `nothing` if no obstacles.
@@ -33,7 +33,7 @@ and similarly for graph traversal costs `delta_tau`.
3333
# Examples
3434
```julia
3535
param, graph = create_graph(init_parameters())
36-
geography = (z = rand(graph.J), obstacles = [1 15; 70 72])
36+
geography = (z = 10*(rand(graph[:J]) .> 0.95), obstacles = [1 15; 70 72])
3737
updated_graph = apply_geography(graph, geography)
3838
```
3939
"""

0 commit comments

Comments
 (0)