Skip to content
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.

Sign up for GitHub

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

Jump to bottom

Anchor examples #348

Merged
merged 2 commits into from
Apr 13, 2016
Merged

Anchor examples #348

merged 2 commits into from
Apr 13, 2016

Conversation

vbatts
Copy link
Member

@vbatts vbatts commented Mar 17, 2016

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

wking
wking reviewed Mar 17, 2016
View reviewed changes
style.md

#### further subheader

### Example
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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.

Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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

Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

this is not all what we do today.

@wking
Copy link
Contributor

wking commented Mar 17, 2016

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
Copy link
Contributor

mrunalp commented Mar 23, 2016

Looks fine. Needs rebase.

@vbatts
Copy link
Member Author

vbatts commented Mar 23, 2016

rebased. PTAL.

@vbatts
*.md: normalize the "example" anchors
547e00b 
Signed-off-by: Vincent Batts <vbatts@hashbangbash.com>
@vbatts vbatts force-pushed the anchor-examples branch from 7b289f1 to a2772db Compare April 8, 2016 14:21
@vbatts
Copy link
Member Author

vbatts commented Apr 8, 2016

updated

wking
wking reviewed Apr 8, 2016
View reviewed changes
style.md
[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
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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

Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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

Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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

@vbatts vbatts force-pushed the anchor-examples branch 2 times, most recently from 7093aad to e49ab0f Compare April 8, 2016 17:58
@wking
Copy link
Contributor

wking commented Apr 8, 2016

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).

@vbatts
style: add a section on examples
7dbab77 
addressing:
* anchoring
* content of example

Signed-off-by: Vincent Batts <vbatts@hashbangbash.com>
@vbatts
Copy link
Member Author

vbatts commented Apr 11, 2016

done. PTAL.

@wking wking mentioned this pull request Apr 11, 2016
Merged
@wking
Copy link
Contributor

wking commented Apr 11, 2016

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
Copy link
Contributor

hqhq commented Apr 13, 2016

LGTM

1 similar comment
@mrunalp
Copy link
Contributor

mrunalp commented Apr 13, 2016

LGTM

@mrunalp mrunalp merged commit d6aea95 into opencontainers:master Apr 13, 2016
@vbatts vbatts deleted the anchor-examples branch April 13, 2016 17:33
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers
No reviews
Assignees
No one assigned
Labels
None yet
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
5 participants
@vbatts @wking @mrunalp @hqhq @RobDolinMS