Add missing docs, improve CLI help

Author: gememma

mirrord/cli/src/config.rs

@@ -801,6 +801,7 @@ pub(super) struct ListTargetArgs {
     pub config_file: Option<PathBuf>,
 
     /// Specify the type of target to be retrieved. If `None`, all types are retrieved.
+    /// Can be used multiple times to specify multiple target types.
     #[arg(short = 't', long)]
     pub target_type: Option<Vec<TargetType>>,
 }

mirrord/cli/src/list.rs

@@ -16,6 +16,8 @@ use tracing::Level;
 
 use crate::{util, CliError, CliResult, Format, ListTargetArgs};
 
+/// Name of the environment variable used to specify which resource types to list with `mirrord ls`.
+/// Primarily used by the plugins when the user picks a target to fetch fewer targets at once.
 const LS_TARGET_TYPES_ENV: &str = "MIRRORD_LS_TARGET_TYPES";
 
 /// A mirrord target found in the cluster.

mirrord/kube/src/api/kubernetes/seeker.rs

@@ -73,9 +73,8 @@ impl KubeResourceSeeker<'_> {
             .collect())
     }
 
-    /// Returns a specified resource type, as long as either:
-    /// 1. The resource type doesn't require the operator
-    /// 2. The operator is being used
+    /// Returns the targets of the specified resource type(s), as long as the operator is active or
+    /// no given types require the operator.
     pub async fn filtered(
         &self,
         resource_types: Vec<TargetType>,
@@ -90,6 +89,9 @@ impl KubeResourceSeeker<'_> {
         .concat())
     }
 
+    /// Returns the targets of a single specified resource type, as long as either:
+    /// 1. The resource type doesn't require the operator
+    /// 2. The operator is being used
     async fn filtered_single(
         &self,
         resource_type: TargetType,