Skip to content

Conversation

@wking
Copy link
Contributor

@wking wking commented Apr 6, 2017

While the other annotations references (e.g. here) use the “This OPTIONAL property…” pattern, config.md puts the OPTIONAL/REQUIRED-ness in the same line as the property name (while manifest.md does not). My preferred larger fix would be to follow runtime-spec and consistently declare OPTIONAL/REQUIRED-ness in the same line as the property name, but that's a bigger change. This commit just removes the redundant OPTIONAL from the description body.

Spun off from here.

While the other annotations references (e.g. for manifest annotations)
use the "This OPTIONAL property..." pattern, config.md puts the
OPTIONAL/REQUIRED-ness in the same line as the property name (while
manifest.md does not).  My preferred larger fix would be to follow
runtime-spec and consistently declare OPTIONAL/REQUIRED-ness in the
same line as the property name, but that's a bigger change.  This
commit just removes the redundant OPTIONAL from the description body.

Signed-off-by: W. Trevor King <[email protected]>
@vbatts
Copy link
Member

vbatts commented Apr 7, 2017

LGTM

Approved with PullApprove

@vbatts vbatts merged commit eb02c88 into opencontainers:master Apr 7, 2017
@wking wking deleted the redundant-optional branch April 7, 2017 16:22
@vbatts vbatts mentioned this pull request May 19, 2017
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants