Skip to content
This repository has been archived by the owner on Jul 23, 2019. It is now read-only.

Suggestion: Don't use overloaded Point and Range terms in API #102

Open
lee-dohm opened this issue Jun 3, 2018 · 2 comments
Open

Suggestion: Don't use overloaded Point and Range terms in API #102

lee-dohm opened this issue Jun 3, 2018 · 2 comments

Comments

@lee-dohm
Copy link

lee-dohm commented Jun 3, 2018

One thing that we ran into problems with the original API were the Point and Range classes. Since the browser APIs contain classes named the same, we ran into naming collisions causing issues for those attempting to use the Atom API. I figured I would record this piece of tribal knowledge here so that we can avoid it in Xray.

Suggestions

Alternatives for Point:

  • Location
  • Coordinate
  • Position

Alternatives for Range:

  • Span
  • Section
  • Bounds
  • Dimension
  • Limits
@Nufflee
Copy link

Nufflee commented Jun 3, 2018

I like Position and Span as they're pretty frequently used in such libraries/APIs.

@nathansobo
Copy link

It might not be as much of an issue in Xray because I think those are DOM globals and we don't intend to make editor APIs available on the main thread. That said, I appreciate you sharing these kinds of thoughts.

Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Labels
None yet
Projects
None yet
Development

No branches or pull requests

3 participants