From 5d3bb18d2529316a862abc9544fe8d9591a67176 Mon Sep 17 00:00:00 2001 From: simonsan <14062932+simonsan@users.noreply.github.com> Date: Fri, 25 Oct 2024 17:16:06 +0200 Subject: [PATCH] docs: update doc strings for dump command Signed-off-by: simonsan <14062932+simonsan@users.noreply.github.com> --- src/commands.rs | 2 +- src/commands/dump.rs | 10 ++++++++-- 2 files changed, 9 insertions(+), 3 deletions(-) diff --git a/src/commands.rs b/src/commands.rs index d991eb3fc..98c0fd091 100644 --- a/src/commands.rs +++ b/src/commands.rs @@ -93,7 +93,7 @@ enum RusticCmd { /// Open the documentation Docs(Box), - /// Dump the contents of a file within a snapshot to stdout + /// Dump the contents of a file within a snapshot Dump(Box), /// Find patterns in given snapshots diff --git a/src/commands/dump.rs b/src/commands/dump.rs index 9c09af678..dc510a8e5 100644 --- a/src/commands/dump.rs +++ b/src/commands/dump.rs @@ -28,11 +28,17 @@ pub(crate) struct DumpCmd { #[clap(value_name = "SNAPSHOT[:PATH]")] snap: String, - /// set archive format to use. Possible values: auto, content, tar, targz, zip. For "auto" format is dertermined by file extension (if given) or "tar" for dirs. + /// Set archive format to use. + /// + /// Possible values: auto, content, tar, targz, zip. + /// + /// # Note + /// + /// For "auto" format is determined by file extension (if given) or "tar" for dirs. #[clap(long, value_name = "FORMAT", default_value = "auto")] archive: ArchiveKind, - /// dump output to the given file. Use this instead of redirecting stdout to a file. + /// Dump output to the given file. Use this instead of redirecting stdout to a file. #[clap(long)] file: Option,