Skip to content

Commit

Permalink
Updated docs
Browse files Browse the repository at this point in the history
  • Loading branch information
MicheleCeresoli committed May 8, 2023
1 parent 9f95110 commit 15743d9
Showing 1 changed file with 2 additions and 2 deletions.
4 changes: 2 additions & 2 deletions docs/src/mappedgraph.md
Original file line number Diff line number Diff line change
Expand Up @@ -87,7 +87,7 @@ Connections between the items in the graph are easily added as follows:
SMDGraphs.add_edge!(graph, 10, 399)
SMDGraphs.add_edge!(graph, 399, 301)
```
By providing an additional integer input to [`add_edge`](@ref), a weight factor
By providing an additional integer input to [`SMDGraphs.add_edge!`](@ref), a weight factor
can be associated to the edge. The default weight is null.

Finally, the path between two nodes is retrived as:
Expand All @@ -97,4 +97,4 @@ julia> print(path)
[2, 1, 3]
```

Note that [`SMDGraphs.get_path`](@ref) returns an integer vector of internal IDs instead of the user-defined ones. This enables a faster retrieval of the nodes via [`SMDGraphs.get_mappednode`](@ref), allowing to avoid the dictionary lookup for the ID mapping of each node in the path.
Note that [`SMDGraphs.get_path`](@ref) returns an integer vector of internal IDs instead of the user-defined ones. This enables a faster retrieval of the nodes via [`SMDGraphs.get_mappednode`](@ref), allowing to skip the dictionary lookup for the ID mapping of each node in the path.

2 comments on commit 15743d9

@MicheleCeresoli
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@JuliaRegistrator register

Release notes:

  • Fixed bug in the edge cost evaluation.
  • Added unit testing
  • Improved documentation

@JuliaRegistrator
Copy link

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Registration pull request created: JuliaRegistries/General/83119

After the above pull request is merged, it is recommended that a tag is created on this repository for the registered package version.

This will be done automatically if the Julia TagBot GitHub Action is installed, or can be done manually through the github interface, or via:

git tag -a v0.1.2 -m "<description of version>" 15743d93b8dfac6f747cddbca4ab84c8c571fdab
git push origin v0.1.2

Please sign in to comment.