Re: [whatwg/streams] Add more cross-links (#872)

surma commented on this pull request.



> @@ -95,7 +95,7 @@ A <dfn export>readable stream</dfn> represents a source of data, from which you
 <em>out</em> of a readable stream. Concretely, a readable stream is an instance of the {{ReadableStream}} class.
 
 Although a readable stream can be created with arbitrary behavior, most readable streams wrap a lower-level I/O source,
-called the <dfn>underlying source</dfn>. There are two types of underlying source: push sources and pull sources.
+called the <dfn>underlying source</dfn> ([[#rs-constructor|interface description]]). There are two types of underlying source: push sources and pull sources.

I see your point. The problem that I’m trying to solve here is the following flow:

1. Go to stream spec
1. Click “ReadableStream” in ToC
1. Get confused, maybe click `ReadableStream` again?
1. Okay, I’m at the class, I see `underlyingSource`, but I can’t click it. The paragraph has a clickable “underlying Source”, tho. So let’s click that.
1. I was already here...

Maybe we can turn `underlyingSource` in the class definition into a link to the note? Would that be acceptable?

-- 
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/872#discussion_r164270948