Re: [whatwg/streams] Editorial: add cross-links to internal slots (#1050)

@domenic commented on this pull request.

This looks quite nice to me. I'd be happy to proceed with this.

Feel free to throw https://github.com/whatwg/streams/pull/1050/commits/154bfb4edada8f7004c621c89c6176a6c96ff075 into https://github.com/whatwg/streams/pull/1051 if you want to morph that into a general "editorial fixups" PR.

> I'm not sure if this is the most compact way to do it? A link like [=ReadableStream/[[readableStreamController]]=] is quite long, but I don't know if there's a way to write only [=[[readableStreamController]]=] and have Bikeshed figure out that it needs to use the ReadableStream namespace. 🤷

The alternative I can think of is just assuming internal slot names are unique, and then removing the `dfn-for=""`. However, we have a few collisions these days (since we are no longer using internal slots for brand checking), and I'd like to introduce more going forward, e.g. `[[readableStreamController]]` -> `[[controller]]`. So that would only work in some cases, and we'd need `for=""` for others. I think this is reasonable.

(As a side note, we might want to do any internal slot renames ahead of this change, since they'll start having anchors that could break after this. However, nobody should really be linking to these externally, so maybe it's fine.)

Finally, we should rewrap all the lines to 100 characters. Hopefully we can find an automated way to do that, although all the tools I've tried are a bit thrown off by the one-space markdown-ish indents. It might be a case of https://xkcd.com/1205/ (or https://xkcd.com/1319/, or https://xkcd.com/974/).

>   <thead>
   <tr>
    <th>Internal Slot
    <th>Description (<em>non-normative</em>)
  <tbody>
   <tr>
-   <td>\[[disturbed]]
+   <td><dfn id="rs-slot-disturbed" lt="[[disturbed]]">\[[disturbed]]</dfn>

We should probably omit the `id=""`s. I regret manually curating them for abstract operations, and I don't think we should set ourselves up for that maintenance burden going forward.

>   <thead>
   <tr>
    <th>Internal Slot
    <th>Description (<em>non-normative</em>)
  <tbody>
   <tr>
-   <td>\[[disturbed]]
+   <td><dfn id="rs-slot-disturbed" lt="[[disturbed]]">\[[disturbed]]</dfn>

The fact that `lt=""` is required here seems like a Bikeshed bug (maybe it's not doing the escaping in the right order). Maybe file an issue on https://github.com/tabatkins/bikeshed?


-- 
You are receiving this because you are subscribed to this thread.
Reply to this email directly or view it on GitHub:
https://github.com/whatwg/streams/pull/1050#pullrequestreview-443356049