You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
docs: Fix link and mention Dfs and Bfs as special case in examples (#816)
I just noticed that the link for the example `Using algorithms on
graphs` in the docs does not work properly because there was a typo.
While at it, I also added a sentence about `Dfs` and `Bfs` not being
found in the algo module and instead in visit.
Similarly, I added links to the docstring of the `Topo` struct which was
referring to other functions/algs without linking to them.
Copy file name to clipboardExpand all lines: src/lib.rs
+4-3Lines changed: 4 additions & 3 deletions
Original file line number
Diff line number
Diff line change
@@ -169,7 +169,7 @@ module documentation lists the available shorthand types.
169
169
170
170
* [Creating an undirected graph and manipulating nodes and edges](#creating-an-undirected-graph-and-manipulating-nodes-and-edges)
171
171
* [Differences of stable and non-stable graphs in index management](#differences-of-stable-and-non-stable-graphs-in-index-management)
172
-
* [Using algorithms on graphs](#usign-algorithms-on-graphs)
172
+
* [Using algorithms on graphs](#using-algorithms-on-graphs)
173
173
* [Associating data with nodes and edges and transmuting the type of the data](#associating-data-with-nodes-and-edges-and-transmuting-the-type-of-the-data)
174
174
* [Exporting graphs to DOT format](#exporting-graphs-to-dot-format)
175
175
@@ -280,8 +280,9 @@ Petgraph provides not only data structures for modeling graphs, but also a wide
280
280
that can be applied to them. For example, given a graph, one can compute shortest paths,
281
281
minimum spanning trees, or even compute the maximal cliques of a graph.
282
282
283
-
Generally, algorithms are found in the [`algo`] module. All of them should include an example of
284
-
how to use them. For example, to compute the minimum spanning tree of a graph, one can use the
283
+
Generally, algorithms are found in the [`algo`] module, except for algorithms like
284
+
depth-/breadth-first-search, which can be found in the [visit] module. All of them should include
285
+
an example of how to use them. For example, to compute the minimum spanning tree of a graph, one can use the
0 commit comments