-
Notifications
You must be signed in to change notification settings - Fork 22.5k
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
[Markdown] [Web/API] Remove summary and seoSummary classes #8110
Comments
Case 1 should be easy to script (a bit tedious to review) |
Yes, we should automate these. Do you think it's OK to have it in 1 PR? |
It is much easier to review by batches of 400. That's what I have done for the spec macros. So they can land quickly, and do not rot. (I review by opening all the pages and checking if all is ok, then a quick scroll of the code) |
I think this is now done! |
...and thanks Jean-Yves for all the reviews! |
Part of #7898.
See also #3923 for some background here.
There are three cases:
seoSummary
orsummary
are used to mark up the first non-macro paragraph. In these cases the classes are effectively a no-op and can be removed without anything changing. We can also automate these cases.seoSummary
orsummary
are used to truncate the first non-macro paragraph (usually taking the first sentence). In these cases it's probably worth checking that the whole first paragraph is reasonable to use as the summary, or whether we should split it. We don't have very precise guidelines for how long this should be though, and given thatseoSummary
andsummary
are usually omitted, I think it's OK to be pretty forgiving here.seoSummary
orsummary
are used to mark up a completely different part of the doc. In this case we should make sure that the first paragraph provides an appropriate summary. https://developer.mozilla.org/en-US/docs/Web/API/Web_Audio_API/Using_AudioWorklet is a good example of a page that uses these classes intentionally, to provide an indirect opening paragraph with a direct summary. We'll need to stop doing things like this.As far as I can tell the breakdown for Web/API is:
4072 pages - no
summary
orseoSummary
1423 pages -
summary
orseoSummary
matches the first paragraph (case 1)345 pages -
summary
orseoSummary
truncates the first paragraph (case 2)86 pages -
summary
orseoSummary
selects a different text (case 3)The text was updated successfully, but these errors were encountered: