Fix: Example code blocks got interpreted as rust code, leading to compilation errors (#743)

client/core/rs/src/api/execute/action.rs

@@ -60,7 +60,7 @@ pub struct BatchRunAction {
   /// Supports multiline and comma delineated combinations of the above.
   ///
   /// Example:
-  /// ```
+  /// ```text
   /// # match all foo-* actions
   /// foo-*
   /// # add some more

client/core/rs/src/api/execute/build.rs

@@ -64,7 +64,7 @@ pub struct BatchRunBuild {
   /// Supports multiline and comma delineated combinations of the above.
   ///
   /// Example:
-  /// ```
+  /// ```text
   /// # match all foo-* builds
   /// foo-*
   /// # add some more

client/core/rs/src/api/execute/deployment.rs

@@ -62,7 +62,7 @@ pub struct BatchDeploy {
   /// Supports multiline and comma delineated combinations of the above.
   ///
   /// Example:
-  /// ```
+  /// ```text
   /// # match all foo-* deployments
   /// foo-*
   /// # add some more
@@ -270,7 +270,7 @@ pub struct BatchDestroyDeployment {
   /// Supports multiline and comma delineated combinations of the above.
   ///
   /// Example:
-  /// ```
+  /// ```text
   /// # match all foo-* deployments
   /// foo-*
   /// # add some more

client/core/rs/src/api/execute/procedure.rs

@@ -48,7 +48,7 @@ pub struct BatchRunProcedure {
   /// Supports multiline and comma delineated combinations of the above.
   ///
   /// Example:
-  /// ```
+  /// ```text
   /// # match all foo-* procedures
   /// foo-*
   /// # add some more

client/core/rs/src/api/execute/repo.rs

@@ -60,7 +60,7 @@ pub struct BatchCloneRepo {
   /// Supports multiline and comma delineated combinations of the above.
   ///
   /// Example:
-  /// ```
+  /// ```text
   /// # match all foo-* repos
   /// foo-*
   /// # add some more
@@ -118,7 +118,7 @@ pub struct BatchPullRepo {
   /// Supports multiline and comma delineated combinations of the above.
   ///
   /// Example:
-  /// ```
+  /// ```text
   /// # match all foo-* repos
   /// foo-*
   /// # add some more
@@ -180,7 +180,7 @@ pub struct BatchBuildRepo {
   /// Supports multiline and comma delineated combinations of the above.
   ///
   /// Example:
-  /// ```
+  /// ```text
   /// # match all foo-* repos
   /// foo-*
   /// # add some more

client/core/rs/src/api/execute/stack.rs

@@ -57,7 +57,7 @@ pub struct BatchDeployStack {
   /// Supports multiline and comma delineated combinations of the above.
   ///
   /// Example:
-  /// ```
+  /// ```text
   /// # match all foo-* stacks
   /// foo-*
   /// # add some more
@@ -115,7 +115,7 @@ pub struct BatchDeployStackIfChanged {
   /// Supports multiline and comma delineated combinations of the above.
   ///
   /// Example:
-  /// ```
+  /// ```text
   /// # match all foo-* stacks
   /// foo-*
   /// # add some more
@@ -172,7 +172,7 @@ pub struct BatchPullStack {
   /// Supports multiline and comma delineated combinations of the above.
   ///
   /// Example:
-  /// ```
+  /// ```text
   /// # match all foo-* stacks
   /// foo-*
   /// # add some more
@@ -368,7 +368,7 @@ pub struct BatchDestroyStack {
   /// Supports multiline and comma delineated combinations of the above.
   ///d
   /// Example:
-  /// ```
+  /// ```text
   /// # match all foo-* stacks
   /// foo-*
   /// # add some more

client/core/rs/src/api/mod.rs

@@ -20,7 +20,7 @@
 //! the schemas given in [read], [mod@write], [execute], and so on.
 //!
 //! For example, this is an example body for [read::GetDeployment]:
-//! ```
+//! ```json
 //! {
 //!   "type": "GetDeployment",
 //!   "params": {
@@ -56,7 +56,7 @@
 //!
 //! Request errors will be returned with a JSON body containing information about the error.
 //! They will have the following common format:
-//! ```
+//! ```json
 //! {
 //!   "error": "top level error message",
 //!   "trace": [

client/core/rs/src/api/read/alert.rs

@@ -20,7 +20,7 @@ pub struct ListAlerts {
   /// Pass a custom mongo query to filter the alerts.
   ///
   /// ## Example JSON
-  /// ```
+  /// ```json
   /// {
   ///   "resolved": "false",
   ///   "level": "CRITICAL",

client/core/rs/src/entities/action.rs

@@ -91,13 +91,13 @@ pub struct ActionConfig {
   /// 1. Regular CRON expression:
   ///
   /// (second, minute, hour, day, month, day-of-week)
-  /// ```
+  /// ```text
   /// 0 0 0 1,15 * ?
   /// ```
   ///
   /// 2. "English" expression via [english-to-cron](https://crates.io/crates/english-to-cron):
   ///
-  /// ```
+  /// ```text
   /// at midnight on the 1st and 15th of the month
   /// ```
   #[serde(default)]

client/core/rs/src/entities/procedure.rs

@@ -91,13 +91,13 @@ pub struct ProcedureConfig {
   /// 1. Regular CRON expression:
   ///
   /// (second, minute, hour, day, month, day-of-week)
-  /// ```
+  /// ```text
   /// 0 0 0 1,15 * ?
   /// ```
   ///
   /// 2. "English" expression via [english-to-cron](https://crates.io/crates/english-to-cron):
   ///
-  /// ```
+  /// ```text
   /// at midnight on the 1st and 15th of the month
   /// ```
   #[serde(default)]

client/core/rs/src/lib.rs

@@ -15,7 +15,7 @@
 //! - `KOMODO_API_SECRET`
 //!
 //! ## Client Example
-//! ```
+//! ```text
 //! dotenvy::dotenv().ok();
 //!
 //! let client = KomodoClient::new_from_env()?;
@@ -109,7 +109,7 @@ impl KomodoClient {
 
   /// Add a healthcheck in the initialization pipeline:
   ///
-  /// ```rust
+  /// ```text
   /// let komodo = KomodoClient::new_from_env()?
   ///   .with_healthcheck().await?;
   /// ```
@@ -121,7 +121,7 @@ impl KomodoClient {
 
   /// Add a healthcheck in the initialization pipeline:
   ///
-  /// ```rust
+  /// ```text
   /// let komodo = KomodoClient::new_from_env()?
   ///   .with_healthcheck().await?;
   /// ```

client/core/rs/src/ws.rs

@@ -61,7 +61,7 @@ impl KomodoClient {
   /// and forwards the updates over a channel.
   /// Handles reconnection internally.
   ///
-  /// ```
+  /// ```text
   /// let (mut rx, _) = komodo.subscribe_to_updates()?;
   /// loop {
   ///   let update = match rx.recv().await {

client/periphery/rs/src/terminal.rs

@@ -44,7 +44,7 @@ impl PeripheryClient {
   /// sentinal value as the expected final line of the stream.
   ///
   /// Example final line:
-  /// ```
+  /// ```text
   /// __KOMODO_EXIT_CODE:0
   /// ```
   ///
@@ -104,7 +104,7 @@ impl PeripheryClient {
   /// sentinal value as the expected final line of the stream.
   ///
   /// Example final line:
-  /// ```
+  /// ```text
   /// __KOMODO_EXIT_CODE:0
   /// ```
   ///