app-route icon indicating copy to clipboard operation
app-route copied to clipboard

`carbon-route` and `route` property introduce naming ambiguity

Open cdata opened this issue 9 years ago • 2 comments

This issue is here to facilitate discussion on an API naming topic.

The proposal is that carbon-route and the route property of same embody distinct concepts respectively, and so either carbon-route should be renamed, or route should be renamed.

Please discuss possible alternatives or arguments against the proposal in this issue!

cdata avatar Mar 03 '16 02:03 cdata

A few disorganized thoughts:

  • route is both a verb and a noun, leading to confusing sentences like Routing is handled by passing the carbon-location's route property to the carbon-route.
  • However, there aren't a ton of good synonyms for route that would fit here. Ideally it should express a point along one path out of many. waypoint is kinda in the right direction.
  • The standard term for the problem domain is routing, so there's significant value in staying close to that metaphor.
  • I think a bunch of us, Scott, Chris, and myself at the least have spent a decent amount of time trying to come up with better naming, but without much progress.
  • I think we are going to rename the match property to pattern, as pattern more clearly represents what it is, as well as being unambiguously a noun.

rictic avatar Mar 03 '16 03:03 rictic

Interestingly, I haven't heard any feedback to this effect so far. Anyone reading this who does find the repetition of carbon-route and the route property confusing, let us know with a comment or reaction!

rictic avatar Mar 29 '16 23:03 rictic