Commit db5d900

committed

Documentation fine-tuning

1 parent 5fa2910 commit db5d900Copy full SHA for db5d900

File tree

+15

-6

lines changed

+15

-6

lines changed

Lines changed: 2 additions & 0 deletions

Original file line number	Diff line number	Diff line change
`@@ -26,6 +26,8 @@`
`26`	`26`	`//! The usage is very simple. These are the primary components:`
`27`	`27`	//! - [`prelude`]
`28`	`28`	//! - [`utils::TreeNode`]
	`29`	+//! - [`utils::ListNode`]
	`30`	+//! - [`utils::symmetric_tree`]
`29`	`31`	`//!`
`30`	`32`	`//!`
`31`	`33`	`//! Additionally, via the support of the cargo make library you can comfortably run your LeetCode`

Lines changed: 3 additions & 2 deletions

Original file line number	Diff line number	Diff line change
`@@ -95,6 +95,7 @@ macro_rules! tree {`
`95`	`95`	`/// Arm 1:`
`96`	`96`	`/// - Takes the value as an argument.`
`97`	`97`	/// - Equivalent of doing `TreeNode::new()`.
	`98`	`+///`
`98`	`99`	`/// Arm 2:`
`99`	`100`	`/// - Takes the value as an argument.`
`100`	`101`	`/// - Also takes a sequence of left and right node values at the same time (which means they're`
`@@ -174,8 +175,6 @@ macro_rules! tree {`
`174`	`175`	`/// };`
`175`	`176`	`/// assert_eq!(node, symmetric_tree!(1, 2, 3, 4));`
`176`	`177`	/// ```
`177`		`-/// Now you have a tree that branches all the way through the right side without having anything on`
`178`		`-/// the left.`
`179`	`178`	`#[macro_export]`
`180`	`179`	`macro_rules! symmetric_tree {`
`181`	`180`	`($val:expr) => {`
`@@ -204,6 +203,7 @@ macro_rules! symmetric_tree {`
`204`	`203`	`/// Arm 1:`
`205`	`204`	`/// - Takes the value as an argument.`
`206`	`205`	/// - Equivalent of doing `TreeNode::new()`.
	`206`	`+///`
`207`	`207`	`/// Arm 2:`
`208`	`208`	`/// - Takes the value as an argument.`
`209`	`209`	/// - Also takes a sequence of left only node values as an argument (and builds the `TreeNode`
`@@ -261,6 +261,7 @@ macro_rules! left_tree {`
`261`	`261`	`/// Arm 1:`
`262`	`262`	`/// - Takes the value as an argument.`
`263`	`263`	/// - Equivalent of doing `TreeNode::new()`.
	`264`	`+///`
`264`	`265`	`/// Arm 2:`
`265`	`266`	`/// - Takes the value as an argument.`
`266`	`267`	/// - Also takes a sequence of right only node values as an argument (and builds the `TreeNode`

Lines changed: 1 addition & 1 deletion

Original file line number	Diff line number	Diff line change
`@@ -3,5 +3,5 @@ use crate::error::Error;`
`3`	`3`	`/// The crate level used result type.`
`4`	`4`	`pub type Result<T> = core::result::Result<T, Error>;`
`5`	`5`
`6`		`-/// Common DSA Re-exports`
	`6`	`+/// Common DSA Re-exports.`
`7`	`7`	`pub use std::collections::{HashMap, HashSet, VecDeque};`

Lines changed: 6 additions & 0 deletions

Original file line number	Diff line number	Diff line change
`@@ -36,11 +36,17 @@ use serde::{Deserialize, Serialize};`
`36`	`36`	`/// ## Big O`
`37`	`37`	`///`
`38`	`38`	`/// Peeking/modifying the first element -> O(1)`
	`39`	`+///`
`39`	`40`	`/// Peeking/modifying the last element -> O(n)`
	`41`	`+///`
`40`	`42`	`/// Removing the first element -> O(1)`
	`43`	`+///`
`41`	`44`	`/// Removing any next element -> O(n)`
	`45`	`+///`
`42`	`46`	`/// Adding a new element at the end -> O(n)`
	`47`	`+///`
`43`	`48`	`/// Adding a new element at the start -> O(1)`
	`49`	`+///`
`44`	`50`	`/// Searching -> O(n)`
`45`	`51`	`#[derive(PartialEq, Eq, Clone, Debug)]`
`46`	`52`	`#[cfg_attr(feature = "serde", derive(Serialize, Deserialize))]`

Lines changed: 3 additions & 3 deletions

Original file line number	Diff line number	Diff line change
`@@ -162,13 +162,13 @@ use std::{cell::RefCell, rc::Rc};`
`162`	`162`	`/// None None None None`
`163`	`163`	/// ```
`164`	`164`	`///`
`165`		`-/// NOTE:`
`166`		`-/// If root->right.val != root->left.val then the tree wouldn't be balanced`
`167`		`-/// The same is the case if root->left->left.val != root->right->right.val.`
	`165`	`+/// NOTE: If root->right.val != root->left.val then the tree wouldn't be balanced. The same is the`
	`166`	`+/// case if root->left->left.val != root->right->right.val.`
`168`	`167`	`///`
`169`	`168`	`/// ## Big O`
`170`	`169`	`///`
`171`	`170`	`/// Traversal (postorder, preorder and inorder) -> O(n)`
	`171`	`+///`
`172`	`172`	`/// Insertion at the start (above the old root) -> O(1)`
`173`	`173`	`///`
`174`	`174`	`/// Any other insertion:`

Comments

(0)