-
Notifications
You must be signed in to change notification settings - Fork 461
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
Conversation
|
||
##### description: short-desc | ||
<a name="tag-description"></a> |
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.
id="" not name=""
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.
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
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.
This is dumb and GitHub is dumb and I am angry :P.
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.
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.
0c5c35d
to
8d84552
Compare
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
a016b9e
to
5b8879b
Compare
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 5bold text [low contrast] outline 4bold text [higher contrast] |
document `timeout` and clean up
Good update! |
Fixes #55
CONTRIBUTING.md
timeout
tagREADME.md