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

Markup: update `es6num` comments in Section 25 #1235

Closed
ryzokuken opened this Issue Jun 17, 2018 · 11 comments

Comments

Projects
None yet
3 participants
@ryzokuken
Contributor

ryzokuken commented Jun 17, 2018

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?

@ljharb

This comment has been minimized.

Show comment
Hide comment
@ljharb

ljharb Jun 17, 2018

Member

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

Member

ljharb commented Jun 17, 2018

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

@jmdyck

This comment has been minimized.

Show comment
Hide comment
@jmdyck

jmdyck Jun 17, 2018

Collaborator

they’re 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.

Collaborator

jmdyck commented Jun 17, 2018

they’re 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.

@ryzokuken

This comment has been minimized.

Show comment
Hide comment
@ryzokuken

ryzokuken Jun 18, 2018

Contributor

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

Making appropriate changes in #1234

Contributor

ryzokuken commented Jun 18, 2018

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

Making appropriate changes in #1234

@ljharb

This comment has been minimized.

Show comment
Hide comment
@ljharb

ljharb Jun 18, 2018

Member

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

Member

ljharb commented Jun 18, 2018

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

@ryzokuken

This comment has been minimized.

Show comment
Hide comment
@ryzokuken

ryzokuken Jun 18, 2018

Contributor

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

Contributor

ryzokuken commented Jun 18, 2018

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

@ryzokuken ryzokuken closed this Jun 18, 2018

@jmdyck

This comment has been minimized.

Show comment
Hide comment
@jmdyck

jmdyck Jun 18, 2018

Collaborator

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.)

Collaborator

jmdyck commented Jun 18, 2018

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.)

@ljharb

This comment has been minimized.

Show comment
Hide comment
@ljharb

ljharb Jun 18, 2018

Member

I did think that, yes. If it doesn’t, then I’m not sure why we bother keeping the comments at all.

Member

ljharb commented Jun 18, 2018

I did think that, yes. If it doesn’t, then I’m not sure why we bother keeping the comments at all.

@ryzokuken

This comment has been minimized.

Show comment
Hide comment
@ryzokuken

ryzokuken Jun 18, 2018

Contributor

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.

Contributor

ryzokuken commented Jun 18, 2018

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.

@ljharb

This comment has been minimized.

Show comment
Hide comment
@ljharb

ljharb Jun 18, 2018

Member

The clause ID does a better job of that though.

Member

ljharb commented Jun 18, 2018

The clause ID does a better job of that though.

@ryzokuken

This comment has been minimized.

Show comment
Hide comment
@ryzokuken

ryzokuken Jun 18, 2018

Contributor

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

Contributor

ryzokuken commented Jun 18, 2018

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

@ljharb

This comment has been minimized.

Show comment
Hide comment
@ljharb

ljharb Jun 18, 2018

Member

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

Member

ljharb commented Jun 18, 2018

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

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment