Merge pull request #660 from FSMaxB/patch-1

davidblewett · web-flow · commit bc4c76a3bb61 · 2024-11-25T00:25:25.000+01:00
Clarify that alter_configs resets unspecified parameters to default
diff --git a/src/admin.rs b/src/admin.rs
@@ -331,7 +331,8 @@ impl<C: ClientContext> AdminClient<C> {
         Ok(rx)
     }
 
-    /// Sets configuration parameters for the specified resources.
+    /// Sets configuration parameters for the specified resources,
+    /// resetting unspecified parameters to their default values.
     ///
     /// Note that while the API supports altering multiple resources at once, it
     /// is not transactional. Alteration of some resources may succeed while

Original file line number	Diff line number	Diff line change
`@@ -331,7 +331,8 @@ impl<C: ClientContext> AdminClient<C> {`
`331`	`331`	`Ok(rx)`
`332`	`332`	`}`
`333`	`333`
`334`		`- /// Sets configuration parameters for the specified resources.`
	`334`	`+ /// Sets configuration parameters for the specified resources,`
	`335`	`+ /// resetting unspecified parameters to their default values.`
`335`	`336`	`///`
`336`	`337`	`/// Note that while the API supports altering multiple resources at once, it`
`337`	`338`	`/// is not transactional. Alteration of some resources may succeed while`