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

Unwrap the heading for the meta element section #5930

Conversation

sideshowbarker
Copy link
Contributor

@sideshowbarker sideshowbarker commented Sep 20, 2020

This patch unwraps the heading for the meta element section from <100 characters back to >100 characters.

Otherwise, without this change, the .pre-process-tag-omission.pl script we use for generating the Tag omission in text/html subsections for every element section doesn’t work as expected for the meta element section.

The reason is, that script is written to read in the source line-by-line and so doesn’t expect any headings to break across multiple lines.

This patch also includes a change adding an admonition to CONTRIBUTING.md about not wrapping element-section headings.


This patch is an alternative to whatwg/html-build#250. I’d personally prefer we make this change to the source rather than that change to the script — because the meta element is actually the only element-section heading we currently have which is longer than breaks across lines. So it seems easier to just unwrap it back to a single line, rather than further touching that script (which is obviously fragile, and touching it risks introduced other regressions).


/index.html ( diff )
/semantics.html ( diff )

This change unwraps the heading for the meta element section from <100
characters back to >100 characters.

Otherwise, without this change, the .pre-process-tag-omission.pl script we
use for generating the **Tag omission in text/html** subsections for every
element section doesn’t work as expected for the meta element section.

The reason is, that script is written to read in the source line-by-line
and so doesn’t expect any headings to break across multiple lines.
This change adds an admonition in the CONTRIBUTING.md file about not
wrapping element-section headings.
@sideshowbarker sideshowbarker force-pushed the sideshowbarker/meta-element-section-heading-unwrap branch from 4b367c1 to bee8505 Compare September 20, 2020 03:32
@sideshowbarker
Copy link
Contributor Author

I think actually I could also pretty easily add a check to the linter to catch this case and ensure we don’t regress it (again, as an alternative to doing the whatwg/html-build#250 fiddling with the perl script).

@domenic
Copy link
Member

domenic commented Sep 21, 2020

Per reasoning in whatwg/html-build#250, I think it's better if we're able to linebreak headings like we do everything else, so I'll close this for now... thanks for taking the time to show both approaches.

@domenic domenic closed this Sep 21, 2020
@annevk annevk deleted the sideshowbarker/meta-element-section-heading-unwrap branch October 15, 2021 11:22
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Development

Successfully merging this pull request may close these issues.

None yet

2 participants