Anchor examples by vbatts · Pull Request #348 · opencontainers/runtime-spec

vbatts · 2016-03-17T02:43:41Z

This cleans up the anchoring of examples and adds to the style and conventions of such.

wking · 2016-03-17T03:33:56Z

+
+#### further subheader
+
+### Example


Maybe clarify that this is an example of “some topic”. And if we prefer Sentence casing or Title Casing, it's probably best to use that throughout this Markdown literal as well.

I agree with @wking. I was confused on first read of lines 28-34 until I read Trevor's comment.

this is not all what we do today.

wking · 2016-03-17T03:40:30Z

On Wed, Mar 16, 2016 at 07:43:44PM -0700, Vincent Batts wrote:

This cleans up the anchoring of examples and adds to the style and
conventions of such.

This is great :). I left a few nits in inline, but I'm happy with
this landing however.

mrunalp · 2016-03-23T17:16:53Z

Looks fine. Needs rebase.

vbatts · 2016-03-23T19:38:34Z

rebased. PTAL.

Signed-off-by: Vincent Batts <vbatts@hashbangbash.com>

vbatts · 2016-04-08T14:21:53Z

updated

wking · 2016-04-08T17:41:05Z

+[no-pointer-for-boolean]: https://github.com/opencontainers/specs/pull/290#discussion_r50296396
+[no-pointer-for-slices]: https://github.com/opencontainers/specs/pull/316/files#r50782982
+[optional-pointer]: https://github.com/opencontainers/specs/pull/233#discussion_r47829711
+[pointer-when-updates-require-changes]: https://github.com/opencontainers/specs/pull/317/files#r50932706


You probably didn't mean to touch the opencontainers/runtime-spec links.

rebased on master ... not sure why those seem touched
On Fri, Apr 8, 2016 at 1:41 PM, W. Trevor King notifications@github.com
wrote:
In style.md
#348 (comment)
:
-[integer-over-hex]: #267 (comment)
-[keep-prefix]: #159 (comment)
-[no-pointer-for-boolean]: #290 (comment)
-[no-pointer-for-slices]: https://github.com/opencontainers/runtime-spec/pull/316/files#r50782982
-[optional-pointer]: #233 (comment)
-[pointer-when-updates-require-changes]: https://github.com/opencontainers/runtime-spec/pull/317/files#r50932706
+[integer-over-hex]: #267 (comment)
+[keep-prefix]: #159 (comment)
+[no-pointer-for-boolean]: #290 (comment)
+[no-pointer-for-slices]: https://github.com/opencontainers/specs/pull/316/files#r50782982
+[optional-pointer]: #233 (comment)
+[pointer-when-updates-require-changes]: https://github.com/opencontainers/specs/pull/317/files#r50932706
You probably didn't mean to touch the opencontainers/runtime-spec links.
—
You are receiving this because you authored the thread.
Reply to this email directly or view it on GitHub
https://github.com/opencontainers/runtime-spec/pull/348/files/a2772db1d89eb9604010aa811cf99e34ae3ddcf5#r59062479

oh i see. "runtime-spec". lemme fix that.
On Fri, Apr 8, 2016 at 1:44 PM, Vincent Batts vbatts@hashbangbash.com
wrote:
rebased on master ... not sure why those seem touched
On Fri, Apr 8, 2016 at 1:41 PM, W. Trevor King notifications@github.com
wrote:
In style.md
#348 (comment)
:
-[integer-over-hex]: #267 (comment)
-[keep-prefix]: #159 (comment)
-[no-pointer-for-boolean]: #290 (comment)
-[no-pointer-for-slices]: https://github.com/opencontainers/runtime-spec/pull/316/files#r50782982
-[optional-pointer]: #233 (comment)
-[pointer-when-updates-require-changes]: https://github.com/opencontainers/runtime-spec/pull/317/files#r50932706
+[integer-over-hex]: #267 (comment)
+[keep-prefix]: #159 (comment)
+[no-pointer-for-boolean]: #290 (comment)
+[no-pointer-for-slices]: https://github.com/opencontainers/specs/pull/316/files#r50782982
+[optional-pointer]: #233 (comment)
+[pointer-when-updates-require-changes]: https://github.com/opencontainers/specs/pull/317/files#r50932706
You probably didn't mean to touch the opencontainers/runtime-spec links.
—
You are receiving this because you authored the thread.
Reply to this email directly or view it on GitHub
https://github.com/opencontainers/runtime-spec/pull/348/files/a2772db1d89eb9604010aa811cf99e34ae3ddcf5#r59062479

wking · 2016-04-08T18:09:10Z

Commits through e49ab0f look good to me, excepting 1 calling for
more context in the example and consistent casing. Something like:

Foo

Bar

Baz

Example

To use Baz, …

Example

To use Foo, …

would make me happier (and the one-word headings avoid the need for a
position on Sentence casing vs. Title Casing).

addressing: * anchoring * content of example Signed-off-by: Vincent Batts <vbatts@hashbangbash.com>

vbatts · 2016-04-11T22:25:27Z

done. PTAL.

wking · 2016-04-11T23:16:02Z

On Mon, Apr 11, 2016 at 03:25:29PM -0700, Vincent Batts wrote:

done. PTAL.

e49ab0f → 7dbab77 looks good to me. I can't think of any other
polishing for 7dbab77.

hqhq · 2016-04-13T03:07:00Z

LGTM

mrunalp · 2016-04-13T17:32:58Z

LGTM

wking reviewed Mar 17, 2016
View reviewed changes

vbatts force-pushed the anchor-examples branch from 534e59b to 7b289f1Compare March 23, 2016 19:38

*.md: normalize the "example" anchors
547e00b
Signed-off-by: Vincent Batts <vbatts@hashbangbash.com>

vbatts force-pushed the anchor-examples branch from 7b289f1 to a2772dbCompare April 8, 2016 14:21

wking reviewed Apr 8, 2016
View reviewed changes

vbatts force-pushed the anchor-examples branch 2 times, most recently from 7093aad to e49ab0fCompare April 8, 2016 17:58

style: add a section on examples
7dbab77
addressing: * anchoring * content of example Signed-off-by: Vincent Batts <vbatts@hashbangbash.com>

vbatts force-pushed the anchor-examples branch from e49ab0f to 7dbab77Compare April 11, 2016 22:25

wking mentioned this pull request Apr 11, 2016
Json schema and examples #370
Merged

mrunalp merged commit d6aea95 into opencontainers:masterApr 13, 2016

vbatts deleted the anchor-examples branch April 13, 2016 17:33

Uh oh!

Conversation

vbatts commented Mar 17, 2016

Uh oh!

wkingMar 17, 2016

Choose a reason for hiding this comment

Uh oh!

RobDolinMSApr 8, 2016

Choose a reason for hiding this comment

Uh oh!

vbattsApr 8, 2016

Choose a reason for hiding this comment

Uh oh!

wking commented Mar 17, 2016

Uh oh!

mrunalp commented Mar 23, 2016

Uh oh!

vbatts commented Mar 23, 2016

Uh oh!

vbatts commented Apr 8, 2016

Uh oh!

wkingApr 8, 2016

Choose a reason for hiding this comment

Uh oh!

vbattsApr 8, 2016

Choose a reason for hiding this comment

Uh oh!

vbattsApr 8, 2016

Choose a reason for hiding this comment

Uh oh!

wking commented Apr 8, 2016

Foo

Bar

Baz

Example

Example

Uh oh!

vbatts commented Apr 11, 2016

Uh oh!

wking commented Apr 11, 2016

Uh oh!

hqhq commented Apr 13, 2016

Uh oh!

mrunalp commented Apr 13, 2016

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

5 participants