Ecma262: Markup: update `es6num` comments in Section 25

Created on 17 Jun 2018  路  11Comments  路  Source: tc39/ecma262

The different sub-sections inside Section 25 are annotated using es6num markup comments like <!-- es6num="25.2" -->. However, these comments weren't updated (and added to new sub-sections) when the Async variants of existing entries were added.

Should these comments be updated/added wherever necessary?

All 11 comments

No, these should never be updated or added - they鈥檙e set in stone to preserve ES6-era links.

they鈥檙e set in stone to preserve ES6-era links

I'm pretty sure that's not the case: they could be removed without breaking links from any era.

If the editors would prefer them gone (to avoid such questions in the future), I can submit a PR.

No, these should never be updated or added - they鈥檙e set in stone to preserve ES6-era links.

Making appropriate changes in https://github.com/tc39/ecma262/pull/1234

No, links from es6 must work for all eternity. Cool urls never change.

@ljharb thanks for the clarification. Closing this in that case, made appropriate changes in #1234.

No, links from es6 must work for all eternity.

Sure, but why do you think that has anything to do with these comments?

Do you think the ecmarkup process looks at them and turns them into anchors? (It doesn't.)

I did think that, yes. If it doesn鈥檛, then I鈥檓 not sure why we bother keeping the comments at all.

I understand why you'd want to remove the comments altogether, they need to be updated and added and add extra layers without doing anything meaningful, but for one, they help people navigate. When you're neck deep in markup, an indicator telling which section you're currently on helps.

The clause ID does a better job of that though.

Just noticed, you're right. It does. So, should I just remove all the comments?

The editors discussed this; and decided to get rid of them (see #1237)

Was this page helpful?
0 / 5 - 0 ratings

Related issues

AlexSHoffman picture AlexSHoffman  路  3Comments

erights picture erights  路  4Comments

michaelficarra picture michaelficarra  路  3Comments

moonformeli picture moonformeli  路  3Comments

ursi picture ursi  路  4Comments