w3c / battery

Battery Status API
https://www.w3.org/TR/battery-status/
Other
24 stars 15 forks source link

editorial: Use Web IDL's definition conventions for methods and getters. #49

Closed rakuco closed 2 years ago

rakuco commented 2 years ago

Aligns with whatwg/webidl#882:


Preview | Diff

rakuco commented 2 years ago

@marcoscaceres @xfq deploying this change to W3C is failing:

  Specberus Errors:
    The <details> element in the header should have attribute "open".
      {
        name: 'headers.details-summary',
        section: 'front-matter',
        rule: 'docIDFormat'
      }
    No GitHub repository issue link. The link is expected to be of the form <code>https://github.com/&lt;USER_OR_ORG&gt;/&lt;REPO_NAME&gt;/issues[/&hellip;]</code>.
      {
        name: 'headers.github-repo',
        section: 'front-matter',
        rule: 'gitRepo'
      }

  Details: https://labs.w3.org/echidna/api/status?id=ba689a50-51a8-4350-9a88-6d9520adcd1c

This check in specberus seems to be related to Process 2021, and I see some recent related ReSpec changes. Any ideas?

xfq commented 2 years ago

The reason for the first error is that the details element does not contain the open attribute (it seems to be added to the DOM by https://www.w3.org/scripts/TR/2021/fixup.js , but it is not in the static HTML file).

The reason for the second error is that the GitHub repo link should appear under Feedback: instead of Participate.

Will report ReSpec issues.

rakuco commented 2 years ago

Thanks, @xfq. FTR, I've fixed the second error with #50.

anssiko commented 2 years ago

@rakuco please merge when all errors have been fixed.

rakuco commented 2 years ago

@anssiko are you referring to this PR or do you mean I should've waited for the details.open bug to be fixed before merging #50?

anssiko commented 2 years ago

All is good now 👍 Feel free to merge fixes needed to keep the build clean without blocking on my review. Sometimes the build breaks and we need to deploy fixes fast so a review from whoever is available is good.

xfq commented 2 years ago

FTR, the first error was also fixed.