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.

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

document timeout and clean up #89

Merged
merged 1 commit into from
Aug 25, 2014

Conversation

smikes
Copy link
Contributor

@smikes smikes commented Aug 22, 2014

Fixes #55

CONTRIBUTING.md

  • document timeout tag
  • reorder tags in frontmatter doc
  • minor cleanups
  • minor fixes
  • add style note
  • reformat flags
  • remove discussion of obsolete $INCLUDE

README.md

  • link to CONTRIBUTING


##### description: short-desc
<a name="tag-description"></a>
Copy link
Member

Choose a reason for hiding this comment

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

id="" not name=""

Copy link
Contributor Author

Choose a reason for hiding this comment

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

Using id= breaks the internal links I added above (see current rev smikes@a112bf7 ) --

This link should go right to the description tag but doesn't: https://github.com/smikes/test262/blob/a112bf7b632569ec18bed26cdd7d48aeea71ab6f/CONTRIBUTING.md#tag-description

Copy link
Member

Choose a reason for hiding this comment

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

This is dumb and GitHub is dumb and I am angry :P.

Copy link
Member

Choose a reason for hiding this comment

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

Actually, I would not include manually-created anchors at all. Even though I understand how they help in some ways, the fact that the user gets a different URL from clicking on an inter-document link vs. clicking on the link octicon that appears on hover over the relevant header is a bad tradeoff IMO.

@smikes smikes force-pushed the CONTRIBUTING-document-timeout branch 3 times, most recently from 0c5c35d to 8d84552 Compare August 25, 2014 15:38
CONTRIBUTING.md
- document `timeout` tag
- reorder tags in frontmatter doc
- minor cleanups
- minor fixes
- add style note
- reformat flags
- remove discussion of obsolete $INCLUDE
- incorporate line notes from @domenic
- integrate additional comments
- add links back, move arg notes down
- Raise outline level by one

README.md
- link to CONTRIBUTING
@smikes smikes force-pushed the CONTRIBUTING-document-timeout branch from a016b9e to 5b8879b Compare August 25, 2014 16:01
@smikes
Copy link
Contributor Author

smikes commented Aug 25, 2014

I made links work, this time linking to the github-generated link. I moved the argument information down so that it doesn't pollute the generated link name. I hoisted all the outline levels up by one to increase contrast between outline level for tags and bold:

outline 5

bold text [low contrast]

outline 4

bold text [higher contrast]

bterlson added a commit that referenced this pull request Aug 25, 2014
@bterlson bterlson merged commit 9bd6686 into tc39:master Aug 25, 2014
@bterlson
Copy link
Member

Good update!

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.

TODO: document setting 'timeout' in tests
3 participants