From 38154d64478182cc3287aeb5766deb1e8392868c Mon Sep 17 00:00:00 2001 From: Leo Li Date: Sat, 23 Nov 2024 15:31:47 -0500 Subject: [PATCH] Apply suggestions from code review MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit Co-authored-by: Laurent Quérel --- src/registry/check.rs | 2 +- src/registry/generate.rs | 2 +- src/registry/mod.rs | 4 ++-- src/registry/resolve.rs | 2 +- src/registry/search.rs | 2 +- src/registry/stats.rs | 2 +- src/registry/update_markdown.rs | 2 +- 7 files changed, 8 insertions(+), 8 deletions(-) diff --git a/src/registry/check.rs b/src/registry/check.rs index afe5f424..d382f3d7 100644 --- a/src/registry/check.rs +++ b/src/registry/check.rs @@ -48,7 +48,7 @@ pub struct RegistryCheckArgs { #[command(flatten)] pub diagnostic: DiagnosticArgs, - /// Weaver parameters + /// Common weaver registry parameters #[command(flatten)] pub common_registry_args: CommonRegistryArgs, } diff --git a/src/registry/generate.rs b/src/registry/generate.rs index a6e41f9f..089b11f4 100644 --- a/src/registry/generate.rs +++ b/src/registry/generate.rs @@ -74,7 +74,7 @@ pub struct RegistryGenerateArgs { #[command(flatten)] pub diagnostic: DiagnosticArgs, - /// Weaver parameters + /// Common weaver registry parameters #[command(flatten)] pub common_registry_args: CommonRegistryArgs, } diff --git a/src/registry/mod.rs b/src/registry/mod.rs index 344feff8..05a5f324 100644 --- a/src/registry/mod.rs +++ b/src/registry/mod.rs @@ -158,8 +158,8 @@ pub fn semconv_registry(log: impl Logger + Sync + Clone, command: &RegistryComma } } -/// Set of Parameters used to specify the extra options for the `weaver` command. -/// The CommonRegistryArgs will be shared across all commands. So only the general options should be +/// Set of Parameters used to specify the extra options for the `weaver registry` command. +/// The CommonRegistryArgs will be shared across all `weaver registry` sub-commands. So only the general options should be /// included here. #[derive(Args, Debug)] pub struct CommonRegistryArgs { diff --git a/src/registry/resolve.rs b/src/registry/resolve.rs index 34d27498..90ee5cfe 100644 --- a/src/registry/resolve.rs +++ b/src/registry/resolve.rs @@ -57,7 +57,7 @@ pub struct RegistryResolveArgs { #[command(flatten)] pub diagnostic: DiagnosticArgs, - // Weaver parameters + // Common weaver registry parameters #[command(flatten)] pub common_registry_args: CommonRegistryArgs, } diff --git a/src/registry/search.rs b/src/registry/search.rs index b1e73cb0..70952672 100644 --- a/src/registry/search.rs +++ b/src/registry/search.rs @@ -53,7 +53,7 @@ pub struct RegistrySearchArgs { /// Otherwise, runs an interactive terminal UI. pub search_string: Option, - /// Weaver parameters + /// Common weaver registry parameters #[command(flatten)] pub common_registry_args: CommonRegistryArgs, } diff --git a/src/registry/stats.rs b/src/registry/stats.rs index 7f64ef3c..181020cc 100644 --- a/src/registry/stats.rs +++ b/src/registry/stats.rs @@ -26,7 +26,7 @@ pub struct RegistryStatsArgs { #[command(flatten)] pub diagnostic: DiagnosticArgs, - /// Weaver parameters + /// Common weaver registry parameters #[command(flatten)] pub common_registry_args: CommonRegistryArgs, } diff --git a/src/registry/update_markdown.rs b/src/registry/update_markdown.rs index 848272de..437aed62 100644 --- a/src/registry/update_markdown.rs +++ b/src/registry/update_markdown.rs @@ -50,7 +50,7 @@ pub struct RegistryUpdateMarkdownArgs { #[command(flatten)] pub diagnostic: DiagnosticArgs, - /// Weaver parameters + /// Common weaver registry parameters #[command(flatten)] pub common_registry_args: CommonRegistryArgs, }