-
Notifications
You must be signed in to change notification settings - Fork 561
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Rewrite mounts description in config.md #443
Conversation
On Mon, May 23, 2016 at 12:06:27AM -0700, Qiang Huang wrote:
“Apple” → “Apply”. And I'm not sure there's consensus about whether the rule applies to |
* **`readonly`** (bool, optional) If true then the root filesystem MUST be read-only inside the container. Defaults to false. | ||
* **`path`** (string, required) Specifies the path to the root filesystem for the container. | ||
A directory MUST exist at the path declared by the field. | ||
* **`readonly`** (bool, optional) If true then the root filesystem MUST be read-only inside the container, defaults to false. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I liked “Defaults to false” better as its own sentence, but I expect folks will get the idea either way ;).
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
And defaults are a general enough idea that it may make more sense to mark them up (e.g. “readonly
(bool, default: false) If true, then …”). So settings would either be required or have a default value.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I liked “Defaults to false” better as its own sentence
I think it makes sense to combine them in one sentence, and it looks simpler, I'll change if more people think we should keep its own sentence.
And defaults are a general enough idea that it may make more sense to mark them up (e.g. “readonly (bool, default: false) If true, then …”). So settings would either be required or have a default value.
Since it's a general change for all such defaults usage in runtime-spec, I'll leave it as a separate discussion if needed.
Updated. |
Also apply one sentence per line rule for list items. Signed-off-by: Qiang Huang <[email protected]>
On Tue, May 31, 2016 at 11:10:29AM -0700, W. Trevor King wrote:
Is there any chance of this landing soon? I want to extend the spec |
Rebased, ping @vbatts @mrunalp @crosbymichael |
@wking I consisted some ':' and ',' usage. |
Also apply one sentence per line rule for list items.
Signed-off-by: Qiang Huang [email protected]