- From: Takeshi Yoshino <notifications@github.com>
- Date: Mon, 29 Feb 2016 00:55:29 -0800
- To: whatwg/streams <streams@noreply.github.com>
- Message-ID: <whatwg/streams/pull/418/c190108302@github.com>
Regarding spec writing, I'd like to get agreement on the following items. Maybe it's good time to establish consistent rules. - id for headings: Keep using abbreviations like `rs-` or just write down all phrases? - e.g. `rs-controller-enqueue` for `enqueue()` in ReadableStreamController, or rename it to `readable-stream-controller-enqueue`? - operation naming: We've been giving names that can be read roughly as an English phrase. I think. But This led to long moving of functions on renaming as they've been placed in the lexicographical order. As we're introducing more hierarchical sections for the abstract operations, the problem would no longer matter, but that said, common prefix is simpler and some times readable than the English phrase like style. What do you think? E.g. `ReadFromReadableStreamReader` would be renamed to just `ReadableStreamReaderRead`. All the operations on ReadableStream would have the same prefix "ReadableStream". - Any preference on the ordering of operations implementing the logic of class methods excluding the brand checking? E.g. GetReadableStreamControllerDesiredSize() would be placed after CloseReadableStreamController() when ordered lexicographically, but the corresponding methods are placed in a different order since in the class representation we're placing getters/setters before the other methods. --- Reply to this email directly or view it on GitHub: https://github.com/whatwg/streams/pull/418#issuecomment-190108302
Received on Monday, 29 February 2016 08:55:59 UTC