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

Editorial: uniformize list-based "or"s and "and"s #9667

Merged
merged 2 commits into from
Sep 1, 2023
Merged

Editorial: uniformize list-based "or"s and "and"s #9667

merged 2 commits into from
Sep 1, 2023

Conversation

domenic
Copy link
Member

@domenic domenic commented Sep 1, 2023

We have used a variety of styles and introductory wordings. This tries to settle on

if one|all of the following are true:

  • condition1;
  • condition2; or|and
  • condition3

This also brings along various small fixes in related areas, such as inserting <p> tags, changing the complete getter steps to modern style, and fixing one <ol> that should have been a <ul>.


/browsers.html ( diff )
/browsing-the-web.html ( diff )
/embedded-content.html ( diff )
/form-control-infrastructure.html ( diff )
/iframe-embed-object.html ( diff )
/links.html ( diff )
/media.html ( diff )
/nav-history-apis.html ( diff )
/popover.html ( diff )
/scripting.html ( diff )
/semantics-other.html ( diff )
/semantics.html ( diff )
/tables.html ( diff )
/webappapis.html ( diff )

Copy link
Member

@annevk annevk left a comment

Choose a reason for hiding this comment

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

Nice, couple optional nits.

source Show resolved Hide resolved
@@ -15464,13 +15466,13 @@ interface <dfn interface>HTMLLinkElement</dfn> : <span>HTMLElement</span> {
<li><p>Let <var>success</var> be true.</p></li>

<li>
<p>If either of the following conditions are met:</p>
<p>If any of the following are true:</p>

<ul>
Copy link
Member

Choose a reason for hiding this comment

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

Optional: should this use class=brief and no nested <p>s in the list items?

Copy link
Member Author

Choose a reason for hiding this comment

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

I think we're very inconsistent on when we use class=brief. I tend to disprefer it myself just out of a subjective feeling that the current styling is too cramped. But I would be fine if we made up some more rigorous rule.

For this PR, I'll try to mostly leave the brief question untouched. (Although I'll remove it from the complete getter because those are relatively long sentences.)

Copy link
Member

Choose a reason for hiding this comment

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

I would be okay with removing it altogether and always using <p>, to be honest. No need for this PR though.

Copy link
Member Author

Choose a reason for hiding this comment

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

I think it has some value for cases like https://html.spec.whatwg.org/#has-an-element-in-scope or https://html.spec.whatwg.org/#the-initial-insertion-mode . But yeah, it feels overused right now.

@@ -27120,26 +27124,33 @@ document.body.appendChild(wbr);</code></pre>
return false.</p>

<li>
<p>Return true if any of the following conditions are true:</p>
<p>If any of the following are true:</p>

<ul class="brief">
Copy link
Member

Choose a reason for hiding this comment

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

Hah, brief and nested <p>!

source Show resolved Hide resolved
source Show resolved Hide resolved
We have used a variety of styles and introductory wordings. This tries to settle on

> if one|all of the following are true:
>
> * condition1;
> * condition2; or|and
> * condition3

This also brings along various small fixes in related areas, such as inserting <p> tags, changing the complete getter steps to modern style, and fixing one <ol> that should have been a <ul>.
@domenic domenic merged commit be6c665 into main Sep 1, 2023
2 checks passed
@domenic domenic deleted the if-any branch September 1, 2023 07:59
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