[PR #743] [MERGED] Fix: Example code blocks got interpreted as rust code, leading to compiler errors #772

New Issue

GiteaMirror · 2025-10-31T15:21:24-05:00

GiteaMirror commented

2025-10-31 15:21:24 -05:00

📋 Pull Request Information

Original PR: https://github.com/moghtech/komodo/pull/743
Author: @MP-Tool
Created: 8/18/2025
Status: ✅ Merged
Merged: 8/20/2025
Merged by: @mbecker20

Base: 1.19.1 ← Head: qa/fix-existing-tests

📝 Commits (2)

1df3686 Fix: Example code blocks got interpreted as rust code, leading to compilation errors
39ae8a9 Merge branch 'moghtech:main' into qa/fix-existing-tests

📊 Changes

13 files changed (+25 additions, -25 deletions)

View changed files

📝 client/core/rs/src/api/execute/action.rs (+1 -1)
📝 client/core/rs/src/api/execute/build.rs (+1 -1)
📝 client/core/rs/src/api/execute/deployment.rs (+2 -2)
📝 client/core/rs/src/api/execute/procedure.rs (+1 -1)
📝 client/core/rs/src/api/execute/repo.rs (+3 -3)
📝 client/core/rs/src/api/execute/stack.rs (+4 -4)
📝 client/core/rs/src/api/mod.rs (+2 -2)
📝 client/core/rs/src/api/read/alert.rs (+1 -1)
📝 client/core/rs/src/entities/action.rs (+2 -2)
📝 client/core/rs/src/entities/procedure.rs (+2 -2)
📝 client/core/rs/src/lib.rs (+3 -3)
📝 client/core/rs/src/ws.rs (+1 -1)
📝 client/periphery/rs/src/terminal.rs (+2 -2)

📄 Description

Generalize doc-test code blocks

Problem:

Several documentation tests (doc-tests) failed because example outputs or illustrative code blocks were interpreted as Rust code, leading to compilation errors.

Solution:

Changed code block types for example outputs from rust to text or added comments, ensuring outputs are treated as illustrative text.

Impact:

All doc-tests now compile and pass reliably. Documentation remains clear.

Note:

cargo needs an updated version of nom.

Finished `test` profile [unoptimized + debuginfo] target(s) in 17.01s
warning: the following packages contain code that will be rejected by a future version of Rust: nom v4.2.3
note: to see what the problems were, use the option `--future-incompat-report`, or run `cargo report future-incompatibilities --id 1`

_{🔄 This issue represents a GitHub Pull Request. It cannot be merged through Gitea due to API limitations.}

## 📋 Pull Request Information **Original PR:** https://github.com/moghtech/komodo/pull/743 **Author:** [@MP-Tool](https://github.com/MP-Tool) **Created:** 8/18/2025 **Status:** ✅ Merged **Merged:** 8/20/2025 **Merged by:** [@mbecker20](https://github.com/mbecker20) **Base:** `1.19.1` ← **Head:** `qa/fix-existing-tests` --- ### 📝 Commits (2) - [`1df3686`](https://github.com/moghtech/komodo/commit/1df3686b8eeaea6b5b1cbf436653853f3930d304) Fix: Example code blocks got interpreted as rust code, leading to compilation errors - [`39ae8a9`](https://github.com/moghtech/komodo/commit/39ae8a9efbf6138a12afad98eeba9143d4f3fc4b) Merge branch 'moghtech:main' into qa/fix-existing-tests ### 📊 Changes **13 files changed** (+25 additions, -25 deletions) <details> <summary>View changed files</summary> 📝 `client/core/rs/src/api/execute/action.rs` (+1 -1) 📝 `client/core/rs/src/api/execute/build.rs` (+1 -1) 📝 `client/core/rs/src/api/execute/deployment.rs` (+2 -2) 📝 `client/core/rs/src/api/execute/procedure.rs` (+1 -1) 📝 `client/core/rs/src/api/execute/repo.rs` (+3 -3) 📝 `client/core/rs/src/api/execute/stack.rs` (+4 -4) 📝 `client/core/rs/src/api/mod.rs` (+2 -2) 📝 `client/core/rs/src/api/read/alert.rs` (+1 -1) 📝 `client/core/rs/src/entities/action.rs` (+2 -2) 📝 `client/core/rs/src/entities/procedure.rs` (+2 -2) 📝 `client/core/rs/src/lib.rs` (+3 -3) 📝 `client/core/rs/src/ws.rs` (+1 -1) 📝 `client/periphery/rs/src/terminal.rs` (+2 -2) </details> ### 📄 Description # Generalize doc-test code blocks ## Problem: Several documentation tests (doc-tests) failed because example outputs or illustrative code blocks were interpreted as Rust code, leading to compilation errors. ## Solution: Changed code block types for example outputs from rust to text or added comments, ensuring outputs are treated as illustrative text. ## Impact: All doc-tests now compile and pass reliably. Documentation remains clear. ## Note: cargo needs an updated version of `nom`. ```text Finished `test` profile [unoptimized + debuginfo] target(s) in 17.01s warning: the following packages contain code that will be rejected by a future version of Rust: nom v4.2.3 note: to see what the problems were, use the option `--future-incompat-report`, or run `cargo report future-incompatibilities --id 1` ``` --- <sub>🔄 This issue represents a GitHub Pull Request. It cannot be merged through Gitea due to API limitations.</sub>

GiteaMirror added the

pull-request

label 2025-10-31 15:21:24 -05:00

GiteaMirror closed this issue

2025-10-31 15:21:24 -05:00

GiteaMirror referenced this issue

2025-10-31 15:21:36 -05:00

[PR #764] [MERGED] 1.19.2 #779

GiteaMirror referenced this issue

2025-10-31 15:21:41 -05:00

[PR #772] [MERGED] Add support for monaco-yaml and docker compose spec validatiaon #782

Sign in to join this conversation.