Skip to content
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

Update some idrefs #207

Merged
merged 2 commits into from
Oct 4, 2023
Merged

Update some idrefs #207

merged 2 commits into from
Oct 4, 2023

Conversation

bkardell
Copy link
Collaborator

In working on a pull for whatwg/html#9795 I ran into the situation where the id on the section which should be to the attribute, the id was "the-math-variant-attribute" which is "fine" but misleading, and a quick scan showed we didn't have ids on all of the sections... This PR just corrects the mislabel and adds addtional ids so that sections can be pointned to...

Note that we are not entirely consistent here - in some cases the id is on the heading, and in others it is on the section containing the heading. I think it's fine but if someone wanted to go make that consistent I wouldn't complain :)

In working on a pull for whatwg/html#9795 I ran into the situation where the id on the section which should be to the <mi> attribute, the id was "the-math-variant-attribute" which is "fine" but misleading, and a quick scan showed we didn't have ids on all of the sections... This PR just corrects the mislabel and adds addtional ids so that sections can be pointned to...

Note that we are not entirely consistent here - in some cases the id is on the heading, and in others it is on the section containing the heading. I think it's fine but if someone wanted to go make that consistent I wouldn't complain :)
Copy link
Contributor

@fred-wang fred-wang left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

So I think respec generally automatically generates the ids from the title. The thing is that we have sometimes been renaming and moving sections around, so we added an id to avoid breaking external links.

In particular sections are referred from meta tag of WPT tests and they are used by the wpt/extract.sh script to generate the data used for inline implementation reports.

I'm OK with this patch, but please make sure external links are updated (at least on MDN and CSS/WHATWG specs and WPT) and that after running the ./extract.sh you don't get errrors with missing ids.

@bkardell
Copy link
Collaborator Author

Ah no no - I misunderstood the intent. I thought we'd added them so that we could have stable refs even if the text changed and we forgot to update it or something. No worries, let's focus on just the ones I think were actually wrong...?

@fred-wang
Copy link
Contributor

Does the script for WPT tests still work with that change? If not maybe we should update the tests to refer to new section id.

@bkardell
Copy link
Collaborator Author

bkardell commented Oct 4, 2023

Merging after some offline discussion with @fred-wang - we're going to follow up on the WPT scripts and use this as a starting point to land some updates.

@bkardell bkardell merged commit 8925975 into main Oct 4, 2023
github-actions bot added a commit that referenced this pull request Oct 4, 2023
SHA: 8925975
Reason: push, by bkardell

Co-authored-by: github-actions[bot] <41898282+github-actions[bot]@users.noreply.github.com>
@Krinkle Krinkle deleted the bkardell-patch-6 branch January 27, 2025 20:58
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants