Skip to content

Commit

Permalink
Cleaning up the formatting of some method comments
Browse files Browse the repository at this point in the history
  • Loading branch information
@mr-adult
mr-adult committed Aug 31, 2023
1 parent ad37a24 commit 920a90b
Show file tree
Hide file tree
Showing 10 changed files with 271 additions and 235 deletions.
30 changes: 16 additions & 14 deletions src/bfs_iterators/borrow.rs
View file
Original file line number Diff line number Diff line change
Expand Up @@ -49,20 +49,22 @@ impl<'a, Node> BorrowedBFSIterator<'a, Node>
///
/// In this traversal, we scan each level of the tree from left to
/// right before going down to the next level.
/// - 0
/// - / \
/// - 1 2
/// - / \ / \
/// - 3 4 5 6
/// - /
/// - 7
/// - \
/// - 8
/// - /
/// - 9
/// - \
/// - 10
///
/// ```
/// 0
/// / \
/// 1 2
/// / \ / \
/// 3 4 5 6
/// /
/// 7
/// \
/// 8
/// /
/// 9
/// \
/// 10
/// ```
///
/// More technical details:
///
/// This method attaches the ancestors of the node to the iterator.
Expand Down
28 changes: 15 additions & 13 deletions src/bfs_iterators/mut_borrow.rs
View file
Original file line number Diff line number Diff line change
Expand Up @@ -49,19 +49,21 @@ impl<'a, Node> MutBorrowedBFSIterator<'a, Node>
///
/// In this traversal, we scan each level of the tree from left to
/// right before going down to the next level.
/// - 0
/// - / \
/// - 1 2
/// - / \ / \
/// - 3 4 5 6
/// - /
/// - 7
/// - \
/// - 8
/// - /
/// - 9
/// - \
/// - 10
/// ```
/// 0
/// / \
/// 1 2
/// / \ / \
/// 3 4 5 6
/// /
/// 7
/// \
/// 8
/// /
/// 9
/// \
/// 10
/// ```
///
/// More technical details:
///
Expand Down
28 changes: 15 additions & 13 deletions src/bfs_iterators/owned.rs
View file
Original file line number Diff line number Diff line change
Expand Up @@ -49,19 +49,21 @@ impl<Node> OwnedBFSIterator<Node>
///
/// In this traversal, we scan each level of the tree from left to
/// right before going down to the next level.
/// - 0
/// - / \
/// - 1 2
/// - / \ / \
/// - 3 4 5 6
/// - /
/// - 7
/// - \
/// - 8
/// - /
/// - 9
/// - \
/// - 10
/// ```
/// 0
/// / \
/// 1 2
/// / \ / \
/// 3 4 5 6
/// /
/// 7
/// \
/// 8
/// /
/// 9
/// \
/// 10
/// ```
///
/// More technical details:
///
Expand Down
28 changes: 15 additions & 13 deletions src/dfs_postorder_iterators/borrow.rs
View file
Original file line number Diff line number Diff line change
Expand Up @@ -48,19 +48,21 @@ impl<'a, Node> BorrowedDFSPostorderIterator<'a, Node>
///
/// In this traversal, each node will only be traversed after all
/// of its children have been traversed.
/// - 0
/// - / \
/// - 1 2
/// - / \ / \
/// - 3 4 5 6
/// - /
/// - 7
/// - \
/// - 8
/// - /
/// - 9
/// - \
/// - 10
/// ```
/// 0
/// / \
/// 1 2
/// / \ / \
/// 3 4 5 6
/// /
/// 7
/// \
/// 8
/// /
/// 9
/// \
/// 10
/// ```
///
/// More technical details:
///
Expand Down
28 changes: 15 additions & 13 deletions src/dfs_postorder_iterators/mut_borrow.rs
View file
Original file line number Diff line number Diff line change
Expand Up @@ -48,19 +48,21 @@ impl<'a, Node> MutBorrowedDFSPostorderIterator<'a, Node>
///
/// In this traversal, each node will only be traversed after all
/// of its children have been traversed.
/// - 0
/// - / \
/// - 1 2
/// - / \ / \
/// - 3 4 5 6
/// - /
/// - 7
/// - \
/// - 8
/// - /
/// - 9
/// - \
/// - 10
/// ```
/// 0
/// / \
/// 1 2
/// / \ / \
/// 3 4 5 6
/// /
/// 7
/// \
/// 8
/// /
/// 9
/// \
/// 10
/// ```
///
/// More technical details:
///
Expand Down
28 changes: 15 additions & 13 deletions src/dfs_postorder_iterators/owned.rs
View file
Original file line number Diff line number Diff line change
Expand Up @@ -48,19 +48,21 @@ impl<Node> OwnedDFSPostorderIterator<Node>
///
/// In this traversal, each node will only be traversed after all
/// of its children have been traversed.
/// - 0
/// - / \
/// - 1 2
/// - / \ / \
/// - 3 4 5 6
/// - /
/// - 7
/// - \
/// - 8
/// - /
/// - 9
/// - \
/// - 10
/// ```
/// 0
/// / \
/// 1 2
/// / \ / \
/// 3 4 5 6
/// /
/// 7
/// \
/// 8
/// /
/// 9
/// \
/// 10
/// ```
///
/// More technical details:
///
Expand Down
28 changes: 15 additions & 13 deletions src/dfs_preorder_iterators/borrow.rs
View file
Original file line number Diff line number Diff line change
Expand Up @@ -44,19 +44,21 @@ impl<'a, Node> BorrowedDFSPreorderIterator<'a, Node>
///
/// In this traversal, each node will only be traversed before any
/// of its children have been traversed.
/// - 0
/// - / \
/// - 1 2
/// - / \ / \
/// - 3 4 5 6
/// - /
/// - 7
/// - \
/// - 8
/// - /
/// - 9
/// - \
/// - 10
/// ```
/// 0
/// / \
/// 1 2
/// / \ / \
/// 3 4 5 6
/// /
/// 7
/// \
/// 8
/// /
/// 9
/// \
/// 10
/// ```
///
/// More technical details:
///
Expand Down
28 changes: 15 additions & 13 deletions src/dfs_preorder_iterators/mut_borrow.rs
View file
Original file line number Diff line number Diff line change
Expand Up @@ -46,19 +46,21 @@ impl<'a, Node> MutBorrowedDFSPreorderIterator<'a, Node>
///
/// In this traversal, each node will only be traversed before any
/// of its children have been traversed.
/// - 0
/// - / \
/// - 1 2
/// - / \ / \
/// - 3 4 5 6
/// - /
/// - 7
/// - \
/// - 8
/// - /
/// - 9
/// - \
/// - 10
/// ```
/// 0
/// / \
/// 1 2
/// / \ / \
/// 3 4 5 6
/// /
/// 7
/// \
/// 8
/// /
/// 9
/// \
/// 10
/// ```
///
/// More technical details:
///
Expand Down
28 changes: 15 additions & 13 deletions src/dfs_preorder_iterators/owned.rs
View file
Original file line number Diff line number Diff line change
Expand Up @@ -46,19 +46,21 @@ impl<Node> OwnedDFSPreorderIterator<Node>
///
/// In this traversal, each node will only be traversed before any
/// of its children have been traversed.
/// - 0
/// - / \
/// - 1 2
/// - / \ / \
/// - 3 4 5 6
/// - /
/// - 7
/// - \
/// - 8
/// - /
/// - 9
/// - \
/// - 10
/// ```
/// 0
/// / \
/// 1 2
/// / \ / \
/// 3 4 5 6
/// /
/// 7
/// \
/// 8
/// /
/// 9
/// \
/// 10
/// ```
///
/// More technical details:
///
Expand Down
Loading

0 comments on commit 920a90b

Please sign in to comment.