Improve rustdoc

sbernauer · sbernauer · commit 3ebcc828c872 · 2025-01-08T11:25:23.000+01:00
diff --git a/crates/stackable-operator/src/role_utils.rs b/crates/stackable-operator/src/role_utils.rs
@@ -219,9 +219,12 @@ impl JvmArgumentOverrides {
         }
     }
 
-    /// Returns all arguments that should be passed to the JVM.
+    /// Called on **merged** [`JvmArgumentOverrides`}, returns all arguments that should be passed to the JVM.
     ///
-    /// **Can only be called on merged config, it will panic otherwise**
+    /// **Can only be called on merged config, it will panic otherwise!**
+    ///
+    ///  We are panicking (instead of returning an Error), because this is not the users fault, but
+    /// the operator is doing things wrong
     pub fn effective_jvm_config_after_merging(&self) -> &Vec<String> {
         assert!(
             self.remove.is_empty(),

Original file line number	Diff line number	Diff line change
`@@ -219,9 +219,12 @@ impl JvmArgumentOverrides {`
`219`	`219`	`}`
`220`	`220`	`}`
`221`	`221`
`222`		`- /// Returns all arguments that should be passed to the JVM.`
	`222`	+ /// Called on merged [`JvmArgumentOverrides`}, returns all arguments that should be passed to the JVM.
`223`	`223`	`///`
`224`		`- /// Can only be called on merged config, it will panic otherwise`
	`224`	`+ /// Can only be called on merged config, it will panic otherwise!`
	`225`	`+ ///`
	`226`	`+ /// We are panicking (instead of returning an Error), because this is not the users fault, but`
	`227`	`+ /// the operator is doing things wrong`
`225`	`228`	`pub fn effective_jvm_config_after_merging(&self) -> &Vec<String> {`
`226`	`229`	`assert!(`
`227`	`230`	`self.remove.is_empty(),`