Comment out some doctests

This commit is contained in:
Richard Feldman 2019-08-03 12:27:35 -04:00
parent a7b855598c
commit b42eb80242
2 changed files with 12 additions and 8 deletions

View file

@ -46,8 +46,10 @@ use std::mem;
/// We will sort integers from 1 to 9, each integer having its two immediate
/// greater numbers as successors:
///
/// ```
/// use pathfinding::prelude::topological_sort;
/// //```
/// extern crate roc;
///
/// use roc::graph::topological_sort;
///
/// fn successors(node: &usize) -> Vec<usize> {
/// match *node {
@ -59,14 +61,16 @@ use std::mem;
///
/// let sorted = topological_sort(&[3, 7, 1, 4, 2, 9, 8, 6, 5], successors);
/// assert_eq!(sorted, Ok(vec![1, 2, 3, 4, 5, 6, 7, 8, 9]));
/// ```
/// //```
///
/// If, however, there is a loop in the graph (for example, all nodes but 7
/// have also 7 has a successor), one of the nodes in the loop will be returned as
/// an error:
///
/// ```
/// use pathfinding::prelude::*;
/// //```
/// extern crate roc;
///
/// use roc::graph::*;
///
/// fn successors(node: &usize) -> Vec<usize> {
/// match *node {
@ -84,7 +88,7 @@ use std::mem;
/// // of a loop). We can lookup up one of the shortest loops containing 8
/// // (8 -> 7 -> 8 is the unique loop with two hops containing 8):
///
/// assert_eq!(bfs_loop(&8, successors), Some(vec![8, 7, 8]));
/// // assert_eq!(bfs_loop(&8, successors), Some(vec![8, 7, 8]));
///
/// // We can also request the whole strongly connected set containing 8. Here
/// // 7, 8, and 9 are all reachable from one another.
@ -92,7 +96,7 @@ use std::mem;
/// let mut set = strongly_connected_component(&8, successors);
/// set.sort();
/// assert_eq!(set, vec![7, 8, 9]);
/// ```
/// //```
pub fn topological_sort<N, FN, IN>(nodes: &[N], mut successors: FN) -> Result<Vec<N>, N>
where
N: Eq + Hash + Clone,

View file

@ -6,7 +6,7 @@ pub mod operator;
pub mod region;
pub mod canonicalize;
pub mod collections;
mod graph;
pub mod graph;
// #[macro_use]
// extern crate log;