wintercg / proposal-sockets-api

Proposal for an API for establishing TCP connections in Non-Browser JavaScript runtime environments
https://sockets-api.proposal.wintercg.org/
Other
46 stars 2 forks source link

Fix Bikeshed issues #5

Closed Ethan-Arrowood closed 1 year ago

Ethan-Arrowood commented 1 year ago

When building the spec using bikeshed command I get the following output:

bikeshed
LINE 71: The heading 'readable attribute' needs a manually-specified ID.
LINE 275: The heading 'AnySocketAddress type' needs a manually-specified ID.
LINE 118: The heading 'closed attribute' needs a manually-specified ID.
LINE 102: The heading 'writable attribute' needs a manually-specified ID.
LINE 238: The heading 'SocketOptions dictionary' needs a manually-specified ID.
WARNING: Multiple elements have the same ID 'starttls-method'.
Deduping, but this ID may not be stable across revisions.
WARNING: Multiple elements have the same ID 'binding-object'.
Deduping, but this ID may not be stable across revisions.
WARNING: Multiple elements have the same ID 'connect'.
Deduping, but this ID may not be stable across revisions.
LINK ERROR: No 'method' refs found for 'connect' with spec 'html'.
{{connect}}
LINK ERROR: No 'idl' refs found for 'starttls()'.
{{starttls()}}
LINT: Unexported dfn that's not referenced locally - did you mean to export it?
<dfn data-dfn-type="dfn" id="securetransport" data-lt="secureTransport" data-noexport="by-default">secureTransport<a href="#securetransport" class="self-link"></a></dfn>
<dfn data-dfn-type="dfn" id="securetransport" data-lt="secureTransport" data-noexport="by-default">secureTransport<a href="#securetransport" class="self-link"></a></dfn>
LINT: Unexported dfn that's not referenced locally - did you mean to export it?
<dfn data-dfn-type="dfn" id="allowhalfopen" data-lt="allowHalfOpen" data-noexport="by-default">allowHalfOpen<a href="#allowhalfopen" class="self-link"></a></dfn>
<dfn data-dfn-type="dfn" id="allowhalfopen" data-lt="allowHalfOpen" data-noexport="by-default">allowHalfOpen<a href="#allowhalfopen" class="self-link"></a></dfn>
LINT: Unexported dfn that's not referenced locally - did you mean to export it?
<dfn data-dfn-type="dfn" id="socketaddress" data-lt="SocketAddress" data-noexport="by-default">SocketAddress<a href="#socketaddress" class="self-link"></a></dfn>
<dfn data-dfn-type="dfn" id="socketaddress" data-lt="SocketAddress" data-noexport="by-default">SocketAddress<a href="#socketaddress" class="self-link"></a></dfn>
 ✔  Successfully generated, with 2 linking errors

We should take some time and fix up theses various warnings/issues.

Ethan-Arrowood commented 1 year ago

https://github.com/speced/bikeshed/issues/2654

Figured out one of our issues is actually a bug 🐛

Ethan-Arrowood commented 1 year ago

closed by #8