diff --git a/.gitignore b/.gitignore index 9d6b1a6a..1b3982e3 100644 --- a/.gitignore +++ b/.gitignore @@ -30,3 +30,5 @@ buck-out **/*.gresource monobean/resources/lib +# Temporary test cache dir +/tests/.cache_tmp \ No newline at end of file diff --git a/gemini/src/lfs/mod.rs b/gemini/src/lfs/mod.rs index d1638d3c..f4249c58 100644 --- a/gemini/src/lfs/mod.rs +++ b/gemini/src/lfs/mod.rs @@ -16,8 +16,9 @@ use crate::{ /// - `file_size`: file_size /// - `origin`: origin /// -/// for example -/// ``` +/// ## Example +/// Here is an example of the JSON payload: +/// ```json /// { /// "bootstrap_node":"https://gitmono.org/relay", /// "file_hash":"52c90a86cb034b7a1c4beb79304fa76bd0a6cbb7b168c3a935076c714bd1c6b6", @@ -70,7 +71,7 @@ pub async fn share_lfs( /// - `file_hash`: file_hash /// /// for example -/// ``` +/// ```json /// { /// "bootstrap_node":"https://gitmono.org/relay", /// "file_hash":"52c90a86cb034b7a1c4beb79304fa76bd0a6cbb7b168c3a935076c714bd1c6b6", @@ -109,7 +110,7 @@ pub async fn get_lfs_chunks_info(bootstrap_node: String, file_hash: String) -> O /// - `file_uri`: file_uri /// /// for example -/// ``` +/// ```json /// { /// "bootstrap_node":"https://gitmono.org/relay", /// "ztm_agent_port":777, diff --git a/mercury/src/internal/object/tree.rs b/mercury/src/internal/object/tree.rs index 14ae5392..dd558396 100644 --- a/mercury/src/internal/object/tree.rs +++ b/mercury/src/internal/object/tree.rs @@ -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 } } @@ -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,