Add comments to main.rs #38
Conversation
Start draft of high-level documentation
There was a problem hiding this comment.
@YJDoc2
Your work is inspiring to me! The comments and documentation will be great for developers, including new contributors. The comments will also greatly increase the likelihood of youki being used as a crate and the comfort of using it.
Have you ever heard of the broken windows theory? The current youki has broken windows due to my failure to comment. However, if you comment, the window will be repaired and cleaned up, and the culture will be such that other developers will also leave comments.
The culture of comments you create will be wonderful.
This is my mistake; a high-level container runtime that includes docker might be appropriate, not just docker, except for the control flow diagram.
|
Hey, Thanks! |
src/main.rs
Outdated
| @@ -66,6 +78,8 @@ impl SubCommand { | |||
| } | |||
| } | |||
|
|
|||
| /// This is the entry point in the container runtime. The binary is run by docker, | |||
There was a problem hiding this comment.
I'd like you to change docker to the high-level container runtime.
src/main.rs
Outdated
| @@ -1,3 +1,7 @@ | |||
| //! # Youki | |||
| //! Container Runtime written in Rust, inspired by [railcar](https://github.com/oracle/railcar) | |||
| //! This crate provides a container runtime which can be used by Docker to run containers. | |||
There was a problem hiding this comment.
I'd like you to change docker to the high-level container runtime.
|
@YJDoc2 I apologize for the confusing explanation. |
|
@utam0k |
Start for #14
I have only commented main.rs, so you can check the commenting style, and let me know if you have something different in mind. If this is fine, after this I'll make a PR of 2-3 files at once as you said in #14.
I have also started a high-level outerview documentation, which will help understand the overall flow and components. I think as I am writing this not knowing much about container runtimes or youki, this will be helpful for new contributors.
Let me know if any changes are required.