docs: Convert arguments lists to actual lists

Author: sbernauer

crates/stackable-operator/src/product_config_utils.rs

@@ -160,17 +160,16 @@ pub fn config_for_role_and_group<'a>(
     Ok(result)
 }
 
-#[allow(clippy::doc_overindented_list_items)]
 /// Given the configuration parameters of all `roles` partition them by `PropertyNameKind` and
 /// merge them with the role groups configuration parameters.
 ///
 /// The output is a map keyed by the role names. The value is also a map keyed by role group names and
 /// the values are the merged configuration properties "bucketed" by `PropertyNameKind`.
 ///
 /// # Arguments
-/// - `resource`  - Not used directly. It's passed on to the `Configuration::compute_*` calls.
-/// - `roles`     - A map keyed by role names. The value is a tuple of a vector of `PropertyNameKind`
-///                 like (Cli, Env or Files) and [`crate::role_utils::Role`] with a boxed [`Configuration`].
+/// - `resource`: Not used directly. It's passed on to the `Configuration::compute_*` calls.
+/// - `roles`: A map keyed by role names. The value is a tuple of a vector of `PropertyNameKind`
+///   like (Cli, Env or Files) and [`crate::role_utils::Role`] with a boxed [`Configuration`].
 #[allow(clippy::type_complexity)]
 pub fn transform_all_roles_to_config<T, U, ProductSpecificCommonConfig>(
     resource: &T::Configurable,
@@ -198,20 +197,19 @@ where
     Ok(result)
 }
 
-#[allow(clippy::doc_overindented_list_items)]
 /// Validates a product configuration for all roles and role_groups. Requires a valid product config
 /// and [`RoleConfigByPropertyKind`] which can be obtained via `transform_all_roles_to_config`.
 ///
 /// # Arguments
-/// - `version`            - The version of the product to be configured.
-/// - `role_config`        - Collected information about all roles, role groups, required
-///                          properties sorted by config files, CLI parameters and ENV variables.
-/// - `product_config`     - The [`product_config::ProductConfigManager`] used to validate the provided
-///                          user data.
-/// - `ignore_warn`        - A switch to ignore product config warnings and continue with
-///                          the value anyways. Not recommended!
-/// - `ignore_err`         - A switch to ignore product config errors and continue with
-///                          the value anyways. Not recommended!
+/// - `version`: The version of the product to be configured.
+/// - `role_config`: Collected information about all roles, role groups, required properties sorted
+///   by config files, CLI parameters and ENV variables.
+/// - `product_config`: The [`product_config::ProductConfigManager`] used to validate the provided
+///   user data.
+/// - `ignore_warn`: A switch to ignore product config warnings and continue with the value anyways.
+///   Not recommended!
+/// - `ignore_err`: A switch to ignore product config errors and continue with the value anyways.
+///   Not recommended!
 pub fn validate_all_roles_and_groups_config(
     version: &str,
     role_config: &RoleConfigByPropertyKind,
@@ -241,22 +239,21 @@ pub fn validate_all_roles_and_groups_config(
     Ok(result)
 }
 
-#[allow(clippy::doc_overindented_list_items)]
 /// Calculates and validates a product configuration for a role and group. Requires a valid
 /// product config and existing [`RoleConfigByPropertyKind`] that can be obtained via
 /// `transform_all_roles_to_config`.
 ///
 /// # Arguments
-/// - `role`               - The name of the role
-/// - `version`            - The version of the product to be configured.
-/// - `properties_by_kind` - Config properties sorted by PropertyKind
-///                          and the resulting user configuration data. See [`RoleConfigByPropertyKind`].
-/// - `product_config`     - The [`product_config::ProductConfigManager`] used to validate the provided
-///                          user data.
-/// - `ignore_warn`        - A switch to ignore product config warnings and continue with
-///                          the value anyways. Not recommended!
-/// - `ignore_err`         - A switch to ignore product config errors and continue with
-///                          the value anyways. Not recommended!
+/// - `role`: The name of the role
+/// - `version`: The version of the product to be configured.
+/// - `properties_by_kind`: Config properties sorted by PropertyKind and the resulting user
+///   configuration data. See [`RoleConfigByPropertyKind`].
+/// - `product_config`: The [`product_config::ProductConfigManager`] used to validate the provided
+///   user data.
+/// - `ignore_warn`: A switch to ignore product config warnings and continue with the value anyways.
+///   Not recommended!
+/// - `ignore_err`: A switch to ignore product config errors and continue with the value anyways.
+///   Not recommended!
 fn validate_role_and_group_config(
     version: &str,
     role: &str,
@@ -286,19 +283,18 @@ fn validate_role_and_group_config(
     Ok(result)
 }
 
-#[allow(clippy::doc_overindented_list_items)]
 /// This transforms the [`product_config::PropertyValidationResult`] back into a pure BTreeMap which can be used
 /// to set properties for config files, cli or environmental variables.
 /// Default values are ignored, Recommended and Valid values are used as is. For Warning and
 /// Error we recommend to not use the values unless you really know what you are doing.
 /// If you want to use the values anyways please check the "ignore_warn" and "ignore_err" switches.
 ///
 /// # Arguments
-/// - `validation_result`   - The product config validation result for each property name.
-/// - `ignore_warn`         - A switch to ignore product config warnings and continue with
-///                           the value anyways. Not recommended!
-/// - `ignore_err`          - A switch to ignore product config errors and continue with
-///                           the value anyways. Not recommended!
+/// - `validation_result`: The product config validation result for each property name.
+/// - `ignore_warn`: A switch to ignore product config warnings and continue with the value anyways.
+///   Not recommended!
+/// - `ignore_err`: A switch to ignore product config errors and continue with the value anyways.
+///   Not recommended!
 // TODO: boolean flags suck, move ignore_warn to be a flag
 fn process_validation_result(
     validation_result: &BTreeMap<String, PropertyValidationResult>,