Skip to content

Commit

Permalink
doc: ignore doc test for log_result!
Browse files Browse the repository at this point in the history
  • Loading branch information
unknowntpo committed Jan 16, 2025
1 parent 6255a13 commit 0444a02
Showing 1 changed file with 1 addition and 19 deletions.
20 changes: 1 addition & 19 deletions clients/filesystem-fuse/src/fuse_api_handle_debug.rs
Original file line number Diff line number Diff line change
Expand Up @@ -43,7 +43,7 @@ use tracing::{debug, error};
///
/// # Usage
///
/// ```
/// ```ignore
/// // No reply printing
/// log_result!(method_call, "method_name", req);
///
Expand All @@ -60,24 +60,6 @@ use tracing::{debug, error};
/// - `$method_name`: A string representing the name of the method for logging purposes.
/// - `$req`: The incoming FUSE request associated with the method call.
/// - `$format_reply_fn`: (Optional) A custom formatting function to describe the reply more specifically.
///
/// # Examples
///
/// ## Example 1: Logging Without Reply Printing
/// ```rust
/// log_result!(some_async_method(), "example_method", req);
/// ```
///
/// ## Example 2: Default Debug Formatting
/// ```rust
/// log_result!(some_async_method(), "example_method_debug", req, debug);
/// ```
///
/// ## Example 3: Custom Reply Formatting
/// Assuming `custom_format_fn` is a function that formats the reply:
/// ```rust
/// log_result!(some_async_method(), "example_method_custom", req, custom_format_fn);
/// ```
macro_rules! log_result {
// No reply printing
($method_call:expr, $method_name:expr, $req:ident) => {
Expand Down

0 comments on commit 0444a02

Please sign in to comment.