pr feedback

rcgoodfellow · rcgoodfellow · commit b016fbe843c7 · 2024-08-26T17:56:17.000-06:00
diff --git a/cli/docs/cli.json b/cli/docs/cli.json
@@ -4623,7 +4623,7 @@
                 {
                   "name": "peer",
                   "about": "Manage BGP peers.",
-                  "long_about": "Manage BGP peers.\n\nThis command provides add and delete subcommands for managing BGP peers.\nBGP peer configuration is a part of a switch port settings configuration.\nThe peer add and remove subcommands perform read-modify-write operations\non switch port settings objects to manage BGP peer configurations.",
+                  "long_about": "Manage BGP peers.\n\nThis command provides set and delete subcommands for managing BGP peers.\nBGP peer configuration is a part of a switch port settings configuration.\nThe peer set and delete subcommands perform read-modify-write operations\non switch port settings objects to manage BGP peer configurations.",
                   "args": [
                     {
                       "long": "profile",
@@ -4697,19 +4697,19 @@
                     },
                     {
                       "name": "set",
-                      "about": "Set a BGP peer to a port configuration",
+                      "about": "Set a BGP peer on a port configuration",
                       "args": [
                         {
                           "long": "addr",
-                          "help": "Address of the peer to add"
+                          "help": "Address of the peer to set the config for"
                         },
                         {
                           "long": "allowed-exports",
                           "help": "Prefixes that may be exported to the peer. Empty list means all prefixes allowed"
                         },
                         {
                           "long": "allowed-imports",
-                          "help": "Prefixes that may be imported form the peer. Empty list means all prefixes allowed"
+                          "help": "Prefixes that may be imported from the peer. Empty list means all prefixes allowed"
                         },
                         {
                           "long": "authstring",
@@ -4725,7 +4725,7 @@
                         },
                         {
                           "long": "connect-retry",
-                          "help": "How long to to wait between TCP connection retries (seconds)"
+                          "help": "How long to wait between TCP connection retries (seconds)"
                         },
                         {
                           "long": "delay-open",
@@ -4795,15 +4795,15 @@
                             "qsfp30",
                             "qsfp31"
                           ],
-                          "help": "Port to add the peer to"
+                          "help": "Port to set the peer config on"
                         },
                         {
                           "long": "profile",
                           "help": "Configuration profile to use for commands"
                         },
                         {
                           "long": "rack",
-                          "help": "Id of the rack to add the peer to"
+                          "help": "Id of the rack to set the peer for"
                         },
                         {
                           "long": "remote-asn",
@@ -4815,7 +4815,7 @@
                             "switch0",
                             "switch1"
                           ],
-                          "help": "Switch to add the peer to"
+                          "help": "Switch to set the peer config on"
                         },
                         {
                           "long": "vlan-id",
@@ -4834,7 +4834,7 @@
                     },
                     {
                       "long": "peer",
-                      "help": "Peer to add the route preference to"
+                      "help": "Peer to set the route preference on"
                     },
                     {
                       "long": "port",
@@ -4872,23 +4872,23 @@
                         "qsfp30",
                         "qsfp31"
                       ],
-                      "help": "Port to add the route preference to"
+                      "help": "Port to set the route preference on"
                     },
                     {
                       "long": "profile",
                       "help": "Configuration profile to use for commands"
                     },
                     {
                       "long": "rack",
-                      "help": "Id of the rack to add the route preference to"
+                      "help": "Id of the rack to set the route preference on"
                     },
                     {
                       "long": "switch",
                       "values": [
                         "switch0",
                         "switch1"
                       ],
-                      "help": "Switch to add the route preference to"
+                      "help": "Switch to set the route preference on"
                     }
                   ]
                 },
@@ -5336,23 +5336,23 @@
                         "qsfp30",
                         "qsfp31"
                       ],
-                      "help": "Port to configure the route on"
+                      "help": "Port to configure the static route on"
                     },
                     {
                       "long": "profile",
                       "help": "Configuration profile to use for commands"
                     },
                     {
                       "long": "rack",
-                      "help": "Id of the rack to configure the route on"
+                      "help": "Id of the rack to configure the static route on"
                     },
                     {
                       "long": "switch",
                       "values": [
                         "switch0",
                         "switch1"
                       ],
-                      "help": "Switch to configure the route on"
+                      "help": "Switch to configure the static route on"
                     },
                     {
                       "long": "vlan-id",
diff --git a/cli/src/cmd_net.rs b/cli/src/cmd_net.rs
@@ -489,19 +489,19 @@ impl AuthenticatedCmd for CmdBgpAuth {
 #[command(verbatim_doc_comment)]
 #[command(name = "pref")]
 pub struct CmdBgpLocalPref {
-    /// Id of the rack to add the route preference to.
+    /// Id of the rack to set the route preference on.
     #[arg(long)]
     rack: Uuid,
 
-    /// Switch to add the route preference to.
+    /// Switch to set the route preference on.
     #[arg(long, value_enum)]
     switch: Switch,
 
-    /// Port to add the route preference to.
+    /// Port to set the route preference on.
     #[arg(long, value_enum)]
     port: Port,
 
-    /// Peer to add the route preference to.
+    /// Peer to set the route preference on.
     #[arg(long)]
     peer: IpAddr,
 
@@ -567,15 +567,15 @@ enum RouteSubCommand {
 #[command(verbatim_doc_comment)]
 #[command(name = "route set")]
 pub struct CmdStaticRouteSet {
-    /// Id of the rack to configure the route on.
+    /// Id of the rack to configure the static route on.
     #[arg(long)]
     rack: Uuid,
 
-    /// Switch to configure the route on.
+    /// Switch to configure the static route on.
     #[arg(long, value_enum)]
     switch: Switch,
 
-    /// Port to configure the route on.
+    /// Port to configure the static route on.
     #[arg(long, value_enum)]
     port: Port,
 
@@ -877,9 +877,9 @@ enum BgpConfigSubCommand {
 
 /// Manage BGP peers.
 ///
-/// This command provides add and delete subcommands for managing BGP peers.
+/// This command provides set and delete subcommands for managing BGP peers.
 /// BGP peer configuration is a part of a switch port settings configuration.
-/// The peer add and remove subcommands perform read-modify-write operations
+/// The peer set and delete subcommands perform read-modify-write operations
 /// on switch port settings objects to manage BGP peer configurations.
 #[derive(Parser, Debug, Clone)]
 #[command(verbatim_doc_comment)]
@@ -901,7 +901,7 @@ impl AuthenticatedCmd for CmdBgpPeer {
 
 #[derive(Parser, Debug, Clone)]
 enum BgpConfigPeerSubCommand {
-    /// Set a BGP peer to a port configuration.
+    /// Set a BGP peer on a port configuration.
     Set(CmdBgpPeerSet),
 
     /// Remove a BGP from a port configuration.
@@ -916,27 +916,27 @@ enum BgpConfigPeerSubCommand {
 #[command(verbatim_doc_comment)]
 #[command(name = "set")]
 pub struct CmdBgpPeerSet {
-    /// Id of the rack to add the peer to.
+    /// Id of the rack to set the peer for.
     #[arg(long)]
     rack: Uuid,
 
-    /// Switch to add the peer to.
+    /// Switch to set the peer config on.
     #[arg(long, value_enum)]
     switch: Switch,
 
-    /// Port to add the peer to.
+    /// Port to set the peer config on.
     #[arg(long, value_enum)]
     port: Port,
 
-    /// Address of the peer to add.
+    /// Address of the peer to set the config for.
     #[arg(long)]
     addr: IpAddr,
 
     /// BGP configuration this peer is associated with.
     #[arg(long)]
     bgp_config: NameOrId,
 
-    /// Prefixes that may be imported form the peer. Empty list means all prefixes
+    /// Prefixes that may be imported from the peer. Empty list means all prefixes
     /// allowed.
     #[arg(long)]
     allowed_imports: Vec<oxnet::IpNet>,
@@ -950,7 +950,7 @@ pub struct CmdBgpPeerSet {
     #[arg(long)]
     communities: Vec<u32>,
 
-    /// How long to to wait between TCP connection retries (seconds).
+    /// How long to wait between TCP connection retries (seconds).
     #[clap(long, default_value_t = 0u32)]
     pub connect_retry: u32,
 

Original file line number	Diff line number	Diff line change
`@@ -4623,7 +4623,7 @@`
`4623`	`4623`	`{`
`4624`	`4624`	`"name": "peer",`
`4625`	`4625`	`"about": "Manage BGP peers.",`
`4626`		`- "long_about": "Manage BGP peers.\n\nThis command provides add and delete subcommands for managing BGP peers.\nBGP peer configuration is a part of a switch port settings configuration.\nThe peer add and remove subcommands perform read-modify-write operations\non switch port settings objects to manage BGP peer configurations.",`
	`4626`	`+ "long_about": "Manage BGP peers.\n\nThis command provides set and delete subcommands for managing BGP peers.\nBGP peer configuration is a part of a switch port settings configuration.\nThe peer set and delete subcommands perform read-modify-write operations\non switch port settings objects to manage BGP peer configurations.",`
`4627`	`4627`	`"args": [`
`4628`	`4628`	`{`
`4629`	`4629`	`"long": "profile",`
`@@ -4697,19 +4697,19 @@`
`4697`	`4697`	`},`
`4698`	`4698`	`{`
`4699`	`4699`	`"name": "set",`
`4700`		`- "about": "Set a BGP peer to a port configuration",`
	`4700`	`+ "about": "Set a BGP peer on a port configuration",`
`4701`	`4701`	`"args": [`
`4702`	`4702`	`{`
`4703`	`4703`	`"long": "addr",`
`4704`		`- "help": "Address of the peer to add"`
	`4704`	`+ "help": "Address of the peer to set the config for"`
`4705`	`4705`	`},`
`4706`	`4706`	`{`
`4707`	`4707`	`"long": "allowed-exports",`
`4708`	`4708`	`"help": "Prefixes that may be exported to the peer. Empty list means all prefixes allowed"`
`4709`	`4709`	`},`
`4710`	`4710`	`{`
`4711`	`4711`	`"long": "allowed-imports",`
`4712`		`- "help": "Prefixes that may be imported form the peer. Empty list means all prefixes allowed"`
	`4712`	`+ "help": "Prefixes that may be imported from the peer. Empty list means all prefixes allowed"`
`4713`	`4713`	`},`
`4714`	`4714`	`{`
`4715`	`4715`	`"long": "authstring",`
`@@ -4725,7 +4725,7 @@`
`4725`	`4725`	`},`
`4726`	`4726`	`{`
`4727`	`4727`	`"long": "connect-retry",`
`4728`		`- "help": "How long to to wait between TCP connection retries (seconds)"`
	`4728`	`+ "help": "How long to wait between TCP connection retries (seconds)"`
`4729`	`4729`	`},`
`4730`	`4730`	`{`
`4731`	`4731`	`"long": "delay-open",`
`@@ -4795,15 +4795,15 @@`
`4795`	`4795`	`"qsfp30",`
`4796`	`4796`	`"qsfp31"`
`4797`	`4797`	`],`
`4798`		`- "help": "Port to add the peer to"`
	`4798`	`+ "help": "Port to set the peer config on"`
`4799`	`4799`	`},`
`4800`	`4800`	`{`
`4801`	`4801`	`"long": "profile",`
`4802`	`4802`	`"help": "Configuration profile to use for commands"`
`4803`	`4803`	`},`
`4804`	`4804`	`{`
`4805`	`4805`	`"long": "rack",`
`4806`		`- "help": "Id of the rack to add the peer to"`
	`4806`	`+ "help": "Id of the rack to set the peer for"`
`4807`	`4807`	`},`
`4808`	`4808`	`{`
`4809`	`4809`	`"long": "remote-asn",`
`@@ -4815,7 +4815,7 @@`
`4815`	`4815`	`"switch0",`
`4816`	`4816`	`"switch1"`
`4817`	`4817`	`],`
`4818`		`- "help": "Switch to add the peer to"`
	`4818`	`+ "help": "Switch to set the peer config on"`
`4819`	`4819`	`},`
`4820`	`4820`	`{`
`4821`	`4821`	`"long": "vlan-id",`
`@@ -4834,7 +4834,7 @@`
`4834`	`4834`	`},`
`4835`	`4835`	`{`
`4836`	`4836`	`"long": "peer",`
`4837`		`- "help": "Peer to add the route preference to"`
	`4837`	`+ "help": "Peer to set the route preference on"`
`4838`	`4838`	`},`
`4839`	`4839`	`{`
`4840`	`4840`	`"long": "port",`
`@@ -4872,23 +4872,23 @@`
`4872`	`4872`	`"qsfp30",`
`4873`	`4873`	`"qsfp31"`
`4874`	`4874`	`],`
`4875`		`- "help": "Port to add the route preference to"`
	`4875`	`+ "help": "Port to set the route preference on"`
`4876`	`4876`	`},`
`4877`	`4877`	`{`
`4878`	`4878`	`"long": "profile",`
`4879`	`4879`	`"help": "Configuration profile to use for commands"`
`4880`	`4880`	`},`
`4881`	`4881`	`{`
`4882`	`4882`	`"long": "rack",`
`4883`		`- "help": "Id of the rack to add the route preference to"`
	`4883`	`+ "help": "Id of the rack to set the route preference on"`
`4884`	`4884`	`},`
`4885`	`4885`	`{`
`4886`	`4886`	`"long": "switch",`
`4887`	`4887`	`"values": [`
`4888`	`4888`	`"switch0",`
`4889`	`4889`	`"switch1"`
`4890`	`4890`	`],`
`4891`		`- "help": "Switch to add the route preference to"`
	`4891`	`+ "help": "Switch to set the route preference on"`
`4892`	`4892`	`}`
`4893`	`4893`	`]`
`4894`	`4894`	`},`
`@@ -5336,23 +5336,23 @@`
`5336`	`5336`	`"qsfp30",`
`5337`	`5337`	`"qsfp31"`
`5338`	`5338`	`],`
`5339`		`- "help": "Port to configure the route on"`
	`5339`	`+ "help": "Port to configure the static route on"`
`5340`	`5340`	`},`
`5341`	`5341`	`{`
`5342`	`5342`	`"long": "profile",`
`5343`	`5343`	`"help": "Configuration profile to use for commands"`
`5344`	`5344`	`},`
`5345`	`5345`	`{`
`5346`	`5346`	`"long": "rack",`
`5347`		`- "help": "Id of the rack to configure the route on"`
	`5347`	`+ "help": "Id of the rack to configure the static route on"`
`5348`	`5348`	`},`
`5349`	`5349`	`{`
`5350`	`5350`	`"long": "switch",`
`5351`	`5351`	`"values": [`
`5352`	`5352`	`"switch0",`
`5353`	`5353`	`"switch1"`
`5354`	`5354`	`],`
`5355`		`- "help": "Switch to configure the route on"`
	`5355`	`+ "help": "Switch to configure the static route on"`
`5356`	`5356`	`},`
`5357`	`5357`	`{`
`5358`	`5358`	`"long": "vlan-id",`