Skip to content

Commit

Permalink
fix[mercury]: update outdated doc test.
Browse files Browse the repository at this point in the history
  • Loading branch information
benjamin-747 committed Feb 27, 2025
1 parent e739a77 commit 1c766b9
Show file tree
Hide file tree
Showing 2 changed files with 5 additions and 18 deletions.
2 changes: 2 additions & 0 deletions .gitignore
Original file line number Diff line number Diff line change
Expand Up @@ -30,3 +30,5 @@ buck-out
**/*.gresource
monobean/resources/lib

# Temporary test cache dir
/tests/.cache_tmp
21 changes: 3 additions & 18 deletions mercury/src/internal/object/tree.rs
Original file line number Diff line number Diff line change
Expand Up @@ -149,22 +149,7 @@ impl Display for TreeItem {
}

impl TreeItem {
/// Create a new TreeItem from a mode, id and name
///
/// # Example
/// ```rust
/// use venus::internal::object::tree::{TreeItem, TreeItemMode};
/// use venus::hash::SHA1;
///
/// // Create an empty TreeItem with the default Hash
/// let default_item = TreeItem::new(TreeItemMode::Blob, SHA1::default(), String::new());
///
/// // Create a blob TreeItem with a custom Hash, and file name
/// let file_item = TreeItem::new(TreeItemMode::Blob, SHA1::new_from_str("1234567890abcdef1234567890abcdef12345678"), String::from("hello.txt"));
///
/// // Create a tree TreeItem with a custom Hash, and directory name
/// let dir_item = TreeItem::new(TreeItemMode::Tree, SHA1::new_from_str("1234567890abcdef1234567890abcdef12345678"), String::from("data"));
/// ```
// Create a new TreeItem from a mode, id and name
pub fn new(mode: TreeItemMode, id: SHA1, name: String) -> Self {
TreeItem { mode, id, name }
}
Expand Down Expand Up @@ -206,8 +191,8 @@ impl TreeItem {
/// Convert a TreeItem to a byte vector
/// ```rust
/// use std::str::FromStr;
/// use venus::internal::object::tree::{TreeItem, TreeItemMode};
/// use venus::hash::SHA1;
/// use mercury::internal::object::tree::{TreeItem, TreeItemMode};
/// use mercury::hash::SHA1;
///
/// let tree_item = TreeItem::new(
/// TreeItemMode::Blob,
Expand Down

0 comments on commit 1c766b9

Please sign in to comment.