Re: [whatwg/dom] Rename Range's 'start' and 'end' to 'range start' and 'range end'. (PR #1168)

> "this's start" but instead just say "start"

That's... not entirely helpful. :) I know that it's completely unambiguous when you focus hard on the words and force your brain to interpret them as technical terms referring to particular data points, but they're such generic terms that it takes extra mental effort to do that. (At least for me, as someone who doesn't spend as much time in the DOM spec.) I do think either the original PR or using Tab's suggestion of “start point” and “end point” would help here.

> [Can't you just](https://github.com/whatwg/dom/pull/1168#issuecomment-1461092830)

If that works, then using that to solve the disambiguation issue sounds reasonable to me, and I'd be in favor of doing it anyway to avoid any future problems. (Still leaves the readability aspect for the DOM spec itself, though.)

> > Fields shouldn't contain the name of the concept they belong to.
> 
> I don't think this is at all universal - we _often_ put the parent term into sub-definitions, for readability. We'll often put in a local-lt without the prefix, so it's not too repetitious in the spec itself, which is most likely to say it a bunch and have the context already, but that's it.

Right, we do this a lot in the CSS specs: it gives flexibility within the spec to include more or less context into the term depending on how much context is needed in that particular instance of use, and also with not exporting overly-generic terms--which helps with avoiding conflicts, but also with readability by including more context into the linking term when it's used from the outside. Like, I would really like to be able to link [=URL fragment=] as a term; [=fragment=] by itself is too vague in a lot of sentences. :/

-- 
Reply to this email directly or view it on GitHub:
https://github.com/whatwg/dom/pull/1168#issuecomment-1464574150
You are receiving this because you are subscribed to this thread.

Message ID: <whatwg/dom/pull/1168/c1464574150@github.com>

Received on Friday, 10 March 2023 22:36:46 UTC