@@ -80,19 +80,19 @@ impl<E: Error> Error for TopologicalSortError<E> {}
8080///
8181/// * `dag`: The DAG to get the topological sorted nodes from
8282/// * `key`: A function that gets passed a single argument, the node id from
83- /// `dag` and is expected to return a key which will be used for
84- /// resolving ties in the sorting order.
83+ /// `dag` and is expected to return a key which will be used for
84+ /// resolving ties in the sorting order.
8585/// * `reverse`: If `false`, perform a regular topological ordering. If `true`,
86- /// return the lexicographical topological order that would have been found
87- /// if all the edges in the graph were reversed. This does not affect the
88- /// comparisons from the `key`.
86+ /// return the lexicographical topological order that would have been found
87+ /// if all the edges in the graph were reversed. This does not affect the
88+ /// comparisons from the `key`.
8989/// * `initial`: If given, the initial node indices to start the topological
90- /// ordering from. If not given, the topological ordering will certainly contain every node in
91- /// the graph. If given, only the `initial` nodes and nodes that are dominated by the
92- /// `initial` set will be in the ordering. Notably, any node that has a natural in degree of
93- /// zero will not be in the output ordering if `initial` is given and the zero-in-degree node
94- /// is not in it. It is not supported to give an `initial` set where the nodes have even
95- /// a partial topological order between themselves and `None` will be returned in this case
90+ /// ordering from. If not given, the topological ordering will certainly contain every node in
91+ /// the graph. If given, only the `initial` nodes and nodes that are dominated by the
92+ /// `initial` set will be in the ordering. Notably, any node that has a natural in degree of
93+ /// zero will not be in the output ordering if `initial` is given and the zero-in-degree node
94+ /// is not in it. It is not supported to give an `initial` set where the nodes have even
95+ /// a partial topological order between themselves and `None` will be returned in this case
9696///
9797/// # Returns
9898///
@@ -348,7 +348,7 @@ where
348348///
349349/// * `graph` - The graph to get the layers from
350350/// * `first_layer` - A list of node ids for the first layer. This
351- /// will be the first layer in the output
351+ /// will be the first layer in the output
352352///
353353/// Will `panic!` if a provided node is not in the graph.
354354/// ```
@@ -503,20 +503,20 @@ where
503503///
504504/// * `graph`: The DAG to find bicolor runs in
505505/// * `filter_fn`: The filter function to use for matching nodes. It takes
506- /// in one argument, the node data payload/weight object, and will return a
507- /// boolean whether the node matches the conditions or not.
508- /// If it returns ``true``, it will continue the bicolor chain.
509- /// If it returns ``false``, it will stop the bicolor chain.
510- /// If it returns ``None`` it will skip that node.
506+ /// in one argument, the node data payload/weight object, and will return a
507+ /// boolean whether the node matches the conditions or not.
508+ /// If it returns ``true``, it will continue the bicolor chain.
509+ /// If it returns ``false``, it will stop the bicolor chain.
510+ /// If it returns ``None`` it will skip that node.
511511/// * `color_fn`: The function that gives the color of the edge. It takes
512- /// in one argument, the edge data payload/weight object, and will
513- /// return a non-negative integer, the edge color. If the color is None,
514- /// the edge is ignored.
512+ /// in one argument, the edge data payload/weight object, and will
513+ /// return a non-negative integer, the edge color. If the color is None,
514+ /// the edge is ignored.
515515///
516516/// # Returns:
517517///
518518/// * `Vec<Vec<G::NodeId>>`: a list of groups with exactly two edge colors, where each group
519- /// is a list of node data payload/weight for the nodes in the bicolor run
519+ /// is a list of node data payload/weight for the nodes in the bicolor run
520520/// * `None` if a cycle is found in the graph
521521/// * Raises an error if found computing the bicolor runs
522522///
@@ -665,9 +665,9 @@ where
665665///
666666/// * `graph`: The DAG to collect runs from
667667/// * `include_node_fn`: A filter function used for matching nodes. It takes
668- /// in one argument, the node data payload/weight object, and returns a
669- /// boolean whether the node matches the conditions or not.
670- /// If it returns ``false``, the node will be skipped, cutting the run it's part of.
668+ /// in one argument, the node data payload/weight object, and returns a
669+ /// boolean whether the node matches the conditions or not.
670+ /// If it returns ``false``, the node will be skipped, cutting the run it's part of.
671671///
672672/// # Returns:
673673///
0 commit comments