Merge pull request #581 from evenfurther/reformat-comment-list

doc: reformat multi-line list items in comments

src/directed/astar.rs

@@ -20,11 +20,11 @@ use crate::FxIndexMap;
 ///
 /// - `start` is the starting node.
 /// - `successors` returns a list of successors for a given node, along with the cost for moving
-/// from the node to the successor. This cost must be non-negative.
+///   from the node to the successor. This cost must be non-negative.
 /// - `heuristic` returns an approximation of the cost from a given node to the goal. The
-/// approximation must not be greater than the real cost, or a wrong shortest path may be returned.
+///   approximation must not be greater than the real cost, or a wrong shortest path may be returned.
 /// - `success` checks whether the goal has been reached. It is not a node as some problems require
-/// a dynamic solution instead of a fixed node.
+///   a dynamic solution instead of a fixed node.
 ///
 /// A node will never be included twice in the path as determined by the `Eq` relationship.
 ///
@@ -157,11 +157,11 @@ where
 ///
 /// - `start` is the starting node.
 /// - `successors` returns a list of successors for a given node, along with the cost for moving
-/// from the node to the successor.
+///   from the node to the successor.
 /// - `heuristic` returns an approximation of the cost from a given node to the goal. The
-/// approximation must not be greater than the real cost, or a wrong shortest path may be returned.
+///   approximation must not be greater than the real cost, or a wrong shortest path may be returned.
 /// - `success` checks whether the goal has been reached. It is not a node as some problems require
-/// a dynamic solution instead of a fixed node.
+///   a dynamic solution instead of a fixed node.
 ///
 /// A node will never be included twice in the path as determined by the `Eq` relationship.
 ///

src/directed/bfs.rs

@@ -17,7 +17,7 @@ use std::iter::FusedIterator;
 /// - `start` is the starting node.
 /// - `successors` returns a list of successors for a given node.
 /// - `success` checks whether the goal has been reached. It is not a node as some problems require
-/// a dynamic solution instead of a fixed node.
+///   a dynamic solution instead of a fixed node.
 ///
 /// A node will never be included twice in the path as determined by the `Eq` relationship.
 ///

src/directed/dfs.rs

@@ -14,7 +14,7 @@ use std::iter::FusedIterator;
 /// - `start` is the starting node.
 /// - `successors` returns a list of successors for a given node, which will be tried in order.
 /// - `success` checks whether the goal has been reached. It is not a node as some problems require
-/// a dynamic solution instead of a fixed node.
+///   a dynamic solution instead of a fixed node.
 ///
 /// A node will never be included twice in the path as determined by the `Eq` relationship.
 ///

src/directed/dijkstra.rs

@@ -19,9 +19,9 @@ use std::hash::Hash;
 ///
 /// - `start` is the starting node.
 /// - `successors` returns a list of successors for a given node, along with the cost for moving
-/// from the node to the successor. This cost must be non-negative.
+///   from the node to the successor. This cost must be non-negative.
 /// - `success` checks whether the goal has been reached. It is not a node as some problems require
-/// a dynamic solution instead of a fixed node.
+///   a dynamic solution instead of a fixed node.
 ///
 /// A node will never be included twice in the path as determined by the `Eq` relationship.
 ///
@@ -111,7 +111,7 @@ where
 ///
 /// - `start` is the starting node.
 /// - `successors` returns a list of successors for a given node, along with the cost for moving
-/// from the node to the successor.
+///   from the node to the successor.
 ///
 /// The result is a map where every reachable node (not including `start`) is associated with
 /// an optimal parent node and a cost from the start node.
@@ -158,7 +158,7 @@ where
 ///
 /// - `start` is the starting node.
 /// - `successors` returns a list of successors for a given node, along with the cost for moving
-/// from the node to the successor.
+///   from the node to the successor.
 /// - `stop` is a function which is called every time a node is examined (including `start`).
 ///   A `true` return value will stop the algorithm.
 ///

src/directed/fringe.rs

@@ -18,11 +18,11 @@ use std::mem;
 ///
 /// - `start` is the starting node.
 /// - `successors` returns a list of successors for a given node, along with the cost for moving
-/// from the node to the successor. This cost must be non-negative.
+///   from the node to the successor. This cost must be non-negative.
 /// - `heuristic` returns an approximation of the cost from a given node to the goal. The
-/// approximation must not be greater than the real cost, or a wrong shortest path may be returned.
+///   approximation must not be greater than the real cost, or a wrong shortest path may be returned.
 /// - `success` checks whether the goal has been reached. It is not a node as some problems require
-/// a dynamic solution instead of a fixed node.
+///   a dynamic solution instead of a fixed node.
 ///
 /// A node will never be included twice in the path as determined by the `Eq` relationship.
 ///

src/directed/idastar.rs

@@ -12,11 +12,11 @@ use num_traits::Zero;
 ///
 /// - `start` is the starting node.
 /// - `successors` returns a list of successors for a given node, along with the cost for moving
-/// from the node to the successor. This cost must be non-negative.
+///   from the node to the successor. This cost must be non-negative.
 /// - `heuristic` returns an approximation of the cost from a given node to the goal. The
-/// approximation must not be greater than the real cost, or a wrong shortest path may be returned.
+///   approximation must not be greater than the real cost, or a wrong shortest path may be returned.
 /// - `success` checks whether the goal has been reached. It is not a node as some problems require
-/// a dynamic solution instead of a fixed node.
+///   a dynamic solution instead of a fixed node.
 ///
 /// A node will never be included twice in the path as determined by the `Eq` relationship.
 ///

src/directed/iddfs.rs

@@ -11,7 +11,7 @@
 /// - `start` is the starting node.
 /// - `successors` returns a list of successors for a given node.
 /// - `success` checks whether the goal has been reached. It is not a node as some problems require
-/// a dynamic solution instead of a fixed node.
+///   a dynamic solution instead of a fixed node.
 ///
 /// A node will never be included twice in the path as determined by the `Eq` relationship.
 ///

src/matrix.rs

@@ -187,7 +187,7 @@ impl<C: Clone> Matrix<C> {
     /// # Errors
     ///
     /// - [`MatrixFormatError::WrongLength`] if the row does not have
-    /// the expected number of elements.
+    ///   the expected number of elements.
     /// - [`MatrixFormatError::EmptyRow`] if an empty row is passed.
     pub fn extend(&mut self, row: &[C]) -> Result<(), MatrixFormatError> {
         if row.is_empty() {
@@ -275,9 +275,9 @@ impl<C> Matrix<C> {
     /// # Errors
     ///
     /// - [`MatrixFormatError::WrongLength`] if the data length does not
-    /// correspond to the announced size
+    ///   correspond to the announced size
     /// - [`MatrixFormatError::EmptyRow`] if the matrix would contain
-    /// an empty row
+    ///   an empty row
     pub fn from_vec(
         rows: usize,
         columns: usize,

src/undirected/connected_components.rs

@@ -46,12 +46,12 @@ fn find(table: &mut [usize], mut x: usize) -> usize {
 /// This function returns a pair containing:
 ///
 /// - A mapping from every vertex to its set identifier. The set identifiers are
-/// opaque and will not necessarily be compact. However, it is guaranteed that
-/// they will not be greater than the number of groups.
+///   opaque and will not necessarily be compact. However, it is guaranteed that
+///   they will not be greater than the number of groups.
 /// - A mapping from every group to its set identifier, with the identifiers being
-/// the same ones as the ones in the previous mapping. Each group corresponds to
-/// the identifier at the same index, except for empty group whose identifier is
-/// set to `std::usize::MAX`.
+///   the same ones as the ones in the previous mapping. Each group corresponds to
+///   the identifier at the same index, except for empty group whose identifier is
+///   set to `std::usize::MAX`.
 ///
 /// Note that if you have a raw undirected graph, you can build
 /// such a structure by creating a group for every vertex containing