docs: improve the docs for containerd-shim-wasm crate #837
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
There was a problem hiding this comment.
Copilot reviewed 5 out of 11 changed files in this pull request and generated no comments.
Files not reviewed (6)
- crates/containerd-shim-wasm/src/container/engine.rs: Evaluated as low risk
- crates/containerd-shim-wasm/src/sandbox/instance_utils.rs: Evaluated as low risk
- crates/containerd-shim-wasm/src/sandbox/mod.rs: Evaluated as low risk
- crates/containerd-shim-wasm/src/sandbox/sync.rs: Evaluated as low risk
- crates/containerd-shim-wasm/src/container/context.rs: Evaluated as low risk
- crates/containerd-shim-wasm/src/container/path.rs: Evaluated as low risk
Comments suppressed due to low confidence (3)
crates/containerd-shim-wasm/README.md:5
- [nitpick] The term 'Wasm' should be consistently used as 'wasm' throughout the documentation.
A library to help build containerd shims for Wasm workloads.
crates/containerd-shim-wasm/README.md:13
- [nitpick] The sentence is grammatically correct but could be clearer. Consider rephrasing for clarity.
What trait to use depends on how much control you need over the container lifecycle and the level of sandboxing you want to provide.
crates/containerd-shim-wasm/README.md:32
- The return type should be
Result<i32, Error>to include the error type.
fn run_wasi(&self, ctx: &impl RuntimeContext) -> Result<i32> {
jprendes
reviewed
Feb 7, 2025
jsturtevant
reviewed
Feb 7, 2025
| @@ -19,7 +19,7 @@ pub(crate) use context::WasiContext; | |||
| pub use context::{Entrypoint, RuntimeContext, Source}; | |||
| pub use engine::Engine; | |||
| pub use instance::Instance; | |||
| pub use path::PathResolve; | |||
| pub(crate) use path::PathResolve; | |||
There was a problem hiding this comment.
Why is this moved to crate?
There was a problem hiding this comment.
Do we have an external use case for this trait? I am not aware so I made it a private one.
There was a problem hiding this comment.
Mostly just wondering. I don't know of any, Did we check our downstream users? Spin-kube in particular?
There was a problem hiding this comment.
Yes, SpinKube is not using this trait
jsturtevant
reviewed
Feb 7, 2025
Mossaka
commented
Feb 7, 2025
Signed-off-by: Jiaxiao (mossaka) Zhou <[email protected]>
Signed-off-by: Jiaxiao (mossaka) Zhou <[email protected]>
There was a problem hiding this comment.
Copilot reviewed 5 out of 11 changed files in this pull request and generated no comments.
Files not reviewed (6)
- README.md: Evaluated as low risk
- crates/containerd-shim-wasm/CHANGELOG.md: Evaluated as low risk
- crates/containerd-shim-wasm/src/container/context.rs: Evaluated as low risk
- crates/containerd-shim-wasm/src/container/engine.rs: Evaluated as low risk
- crates/containerd-shim-wasm/src/sandbox/mod.rs: Evaluated as low risk
- crates/containerd-shim-wasm/src/sandbox/sync.rs: Evaluated as low risk
jprendes
approved these changes
Feb 11, 2025
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Note that breaking change is in this PR that PathResolve is made to be
crate publicinstead ofpublic.Closes #823