Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

find a better name for the PauseFrame API? #10

Closed
dbaron opened this issue Sep 14, 2017 · 3 comments
Closed

find a better name for the PauseFrame API? #10

dbaron opened this issue Sep 14, 2017 · 3 comments

Comments

@dbaron
Copy link

dbaron commented Sep 14, 2017

The name "PauseFrame API" seems problematic to me, because "frame" already means at least three different things on the Web platform:

  1. an element that holds a subdocument (as in <iframe>)
  2. a tick of an animation or of the browser refresh cycle (as in requestAnimationFrame())
  3. a stack frame in JS

Associating the words "pause" and "frame" together leads me, and I suspect others, to assume that frame in this context is usage (2) (i.e., that this is an api about animations) rather than usage (1).

My inclination is that you should probably avoid the term "frame" in the title of the specification because of this potential confusion, and because of the (maybe) general principle that overused/confusable terms should be used as little as possible.

I'm not sure if that implies anything about the names exposed in the API surface...

(I got here from w3ctag/design-reviews#196. But just my own opinion at this point; not speaking for the TAG.)

@dbaron
Copy link
Author

dbaron commented Sep 27, 2017

(Maybe "Pause Document API" would work?)

@jkarlin
Copy link
Owner

jkarlin commented Oct 2, 2017

Pause Document or Pause IFrame both seem reasonable to me. I went with frame over iframe because we ought to include frames as well. Pause Document accomplishes that.

@jkarlin
Copy link
Owner

jkarlin commented Nov 2, 2017

Done. Now renamed to PauseDocument.

@jkarlin jkarlin closed this as completed Nov 2, 2017
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

2 participants