Added docs for new and default.

alexfertel · Jun 13, 2024 · 3ea6cb5 · 3ea6cb5
1 parent d7191ef
commit 3ea6cb5
Showing 1 changed file with 22 additions and 0 deletions.
diff --git a/src/data_structures/binary_search_tree.rs b/src/data_structures/binary_search_tree.rs
@@ -47,6 +47,17 @@ where
  T: Ord,
 {
 
+ /// Create a new, empty `BinarySearchTree`.
+ ///
+ /// # Examples
+ ///
+ /// ```rust
+ /// use rust_algorithms::data_structures::BinarySearchTree;
+ ///
+ /// let tree: BinarySearchTree<i32> = BinarySearchTree::default();
+ ///
+ /// assert!(tree.is_empty());
+ /// ```
  fn default() -> Self {
  Self::new()
  }
@@ -57,6 +68,17 @@ where
  T: Ord,
 {
 
+ /// Create a new, empty `BinarySearchTree`.
+ ///
+ /// # Examples
+ ///
+ /// ```rust
+ /// use rust_algorithms::data_structures::BinarySearchTree;
+ ///
+ /// let tree: BinarySearchTree<i32> = BinarySearchTree::new();
+ ///
+ /// assert!(tree.is_empty());
+ /// ```
  pub fn new() -> BinarySearchTree<T> {
  BinarySearchTree {
  value: None,