tyler.durden
/
test262
mirror of https://github.com/tc39/test262.git
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity

Merge pull request #1262 from bocoup/contributing-fix 

Fix CONTRIBUTING.md description of the info frontmatter tag
This commit is contained in:
Leo Balter 2017-10-04 19:36:20 -04:00 committed by GitHub
parent b3092c61b6 22391e518a
commit bf8c575163
1 changed files with 19 additions and 4 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

23
CONTRIBUTING.md
View File

@ -30,7 +30,7 @@ A test file has three sections: Copyright, Frontmatter, and Body. A test looks
description: brief description description: brief description
info: > info: >
verbose test description, multiple lines OK. verbose test description, multiple lines OK.
(this is rarely necessary, usually description is enough) (info typically contains relevant, direct quote from ECMAScript)
---*/ ---*/
[Test Code] [Test Code]
@ -70,10 +70,25 @@ Eg: Insert <LS> between chunks of one string
#### info #### info
**info**: [multiline string] **info**: [multiline string]
This allows a long, free-form comment. This allows a long, free-form comment. The comment is almost always a direct
quote from ECMAScript. It is used to indicate the observable being tested
within the file.
Eg: Object.prototype.toString - '[object Null]' will be returned when For example:
'this' value is null
/*---
esid: sec-weakset.prototype.has
description: Throws TypeError if `this` is not Object.
info: >
WeakSet.prototype.has ( value )
1. Let S be the this value.
2. If Type(S) is not Object, throw a TypeError exception.
---*/
Note: Adding more context than the direct quote from ECMAScript should rarely
be necessary. If you must add context to the quote, use the JavaScript
single line comment syntax.
#### negative #### negative
**negative**: [dictionary containing **phase** and **type**] **negative**: [dictionary containing **phase** and **type**]