Skip to content

Commit 8536a4b

Browse files
authored
Merge pull request mitchmindtree#37 from kesyog/fix-doc-links
2 parents f6c00a5 + 1abaef1 commit 8536a4b

File tree

1 file changed

+10
-11
lines changed

1 file changed

+10
-11
lines changed

src/lib.rs

Lines changed: 10 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -4,15 +4,14 @@
44
//! data structure, exposing a refined API targeted towards directed acyclic graph related
55
//! functionality.
66
//!
7-
//! The [**Walker** trait](Walker) defines a variety of useful methods for
8-
//! traversing any graph type. Its methods behave similarly to iterator types, however **Walker**s
9-
//! do not require borrowing the graph. This means that we can still safely mutably borrow from the
10-
//! graph whilst we traverse it.
7+
//! The [`Walker`] trait defines a variety of useful methods for traversing any graph type. Its
8+
//! methods behave similarly to iterator types, however **Walker**s do not require borrowing the
9+
//! graph. This means that we can still safely mutably borrow from the graph whilst we traverse it.
1110
//!
1211
//!
13-
//! [1]: https://docs.rs/daggy/latest/daggy/struct.Dag.html
14-
//! [2]: https://docs.rs/petgraph/0.7.1/petgraph/
15-
//! [3]: https://docs.rs/petgraph/0.7.1/petgraph/graph/struct.Graph.html
12+
//! [1]: Dag
13+
//! [2]: petgraph
14+
//! [3]: petgraph::graph::Graph
1615
1716
#![forbid(unsafe_code)]
1817
#![warn(missing_docs)]
@@ -283,8 +282,8 @@ where
283282
/// Returns the index of the new node.
284283
///
285284
/// **Note:** If you're adding a new node and immediately adding a single edge to that node from
286-
/// some other node, consider using the [add_child](./struct.Dag.html#method.add_child) or
287-
/// [add_parent](./struct.Dag.html#method.add_parent) methods instead for better performance.
285+
/// some other node, consider using the [add_child](Dag::add_child) or
286+
/// [add_parent](Dag::add_parent) methods instead for better performance.
288287
///
289288
/// **Panics** if the Graph is at the maximum number of nodes for its index type.
290289
pub fn add_node(&mut self, weight: N) -> NodeIndex<Ix> {
@@ -414,7 +413,7 @@ where
414413
///
415414
/// If the edge doesn't already exist, it will be added using the `add_edge` method.
416415
///
417-
/// Please read the [`add_edge`](./struct.Dag.html#method.add_edge) for more important details.
416+
/// Please read the [`add_edge`](Dag::add_edge) method documentation for more important details.
418417
///
419418
/// Checks if the edge would create a cycle in the Graph.
420419
///
@@ -425,7 +424,7 @@ where
425424
/// cycle.
426425
///
427426
/// **Note:** If you're adding a new node and immediately adding a single edge to that node from
428-
/// some parent node, consider using the [`add_child`](./struct.Dag.html#method.add_child)
427+
/// some parent node, consider using the [`add_child`](Dag::add_child)
429428
/// method instead for greater convenience.
430429
///
431430
/// **Panics** if the Graph is at the maximum number of nodes for its index type.

0 commit comments

Comments
 (0)