Use consistent ordering for documenting test frontmatter keys

This commit is contained in:
Richard Gibson 2019-03-29 14:07:48 -04:00
parent de567d3aa5
commit bcb5a2cbdd
1 changed files with 8 additions and 8 deletions

View File

@ -53,9 +53,9 @@ The Test262 frontmatter is a string of [YAML](https://en.wikipedia.org/wiki/YAML
Test262 supports the following tags:
- [**description**](#description) (required)
- [**esid**](#esid) (required for new tests)
- [**info**](#info)
- [**negative**](#negative)
- [**esid**](#esid) (required for new tests)
- [**includes**](#includes)
- [**timeout**](#timeout)
- [**author**](#author)
@ -74,6 +74,13 @@ This is one of two required frontmatter tags. The description should be a short,
Eg: Insert <LS> between chunks of one string
#### esid
**esid**: [spec-id]
This tag is required for all new feature tests. This tag identifies the hash ID from the portion of the ECMAScript draft which is most recent to the date the test was added. It represents the anchors on the generated HTML version of the specs. E.g.: `esid: sec-typedarray-length`. This tag might be used to replace a `es6id` or further.
When writing a new test for a Stage 3+ spec not yet published on the draft, the `pending` value can be used while a hash ID is not available.
#### info
**info**: [multiline string]
@ -115,13 +122,6 @@ For example:
phase: parse
type: ReferenceError
#### esid
**esid**: [spec-id]
This tag is required for all new feature tests. This tag identifies the hash ID from the portion of the ECMAScript draft which is most recent to the date the test was added. It represents the anchors on the generated HTML version of the specs. E.g.: `esid: sec-typedarray-length`. This tag might be used to replace a `es6id` or further.
When writing a new test for a Stage 3+ spec not yet published on the draft, the `pending` value can be used while a hash ID is not available.
#### includes
**includes**: [file-list]