WICG / crash-reporting

Crash reporting (from Web Perf WG)
https://wicg.github.io/crash-reporting/
Other
8 stars 7 forks source link

Do not export CrashReportBody to reffy #8

Closed stephenmcgruer closed 4 years ago

stephenmcgruer commented 4 years ago

User agents are not expected to implement CrashReportBody, since the report cannot ever be received in JavaScript (because the browser has crashed!). As such, there is no reason to export this to reffy and try to test it in WPT, see https://github.com/web-platform-tests/wpt/pull/24190

stephenmcgruer commented 4 years ago

@foolip - can you confirm if this is correct?

@clelland - I wasn't sure about re-generating the HTML here; I tried using hosted bikeshed but it seemed to update a bunch of lines, is that expected?

clelland commented 4 years ago

The regenerated HTML looks good; possibly just a more recent version of bikeshed than the one that the previous version was built with. Besides the slight differences to the styling, the differences I see are:

foolip commented 4 years ago

@stephenmcgruer yes, this should do the trick.

clelland commented 4 years ago

Thanks, @foolip -- merging this.

tidoust commented 4 years ago

I believe that the right way to exclude IDL in Bikeshed is rather to use an extract class (and not export), see: https://github.com/tabatkins/bikeshed/issues/946 https://tabatkins.github.io/bikeshed/#no-idl

As things stand, the IDL still appears in the IDL index at the end of the spec, which Reffy uses in Bikeshed specs.

(The use of extract may not be perfect in any case, as these classes are more meant to exclude IDL that is just an example than to document IDL that is not meant to be exposed to browsers, but then I don't think that there exists a mechanism to flag the latter)

clelland commented 4 years ago

Hmm... not sure anymore if we're holding this thing right. @tabatkins, can you provide any guidance here?

foolip commented 4 years ago

Oh, so Reffy uses Bikeshed's IDL index and so we need to use the class that Bikeshed cares about, extract. Reffy also excludes things with exclude, but that doesn't matter... Oops, sorry for giving the wrong suggestion!