4
4
//! data structure, exposing a refined API targeted towards directed acyclic graph related
5
5
//! functionality.
6
6
//!
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.
11
10
//!
12
11
//!
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
16
15
17
16
#![ forbid( unsafe_code) ]
18
17
#![ warn( missing_docs) ]
@@ -283,8 +282,8 @@ where
283
282
/// Returns the index of the new node.
284
283
///
285
284
/// **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.
288
287
///
289
288
/// **Panics** if the Graph is at the maximum number of nodes for its index type.
290
289
pub fn add_node ( & mut self , weight : N ) -> NodeIndex < Ix > {
@@ -414,7 +413,7 @@ where
414
413
///
415
414
/// If the edge doesn't already exist, it will be added using the `add_edge` method.
416
415
///
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.
418
417
///
419
418
/// Checks if the edge would create a cycle in the Graph.
420
419
///
@@ -425,7 +424,7 @@ where
425
424
/// cycle.
426
425
///
427
426
/// **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)
429
428
/// method instead for greater convenience.
430
429
///
431
430
/// **Panics** if the Graph is at the maximum number of nodes for its index type.
0 commit comments