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

Improve consistency of terminology in documentation #52

Open
NickEntin opened this issue Oct 26, 2020 · 1 comment
Open

Improve consistency of terminology in documentation #52

NickEntin opened this issue Oct 26, 2020 · 1 comment
Labels
documentation Improvements or additions to documentation

Comments

@NickEntin
Copy link
Collaborator

We should be more consistent with the terminology we use in the project - both in the long form documentation and headerdocs, as well as some of the (private) variable names. For example, when talking about durations, the "duration" can apply to different parts of the animation, so I've started differentiating by saying:

  • The time from the start of the execution phase to when the animation completes is the end-to-end duration. This is usually a calculated value based on the cycle duration and the repeat style (when available).
  • The time for the animation to go from a relative timestamp of 0 to 1 (or 1 to 0) is the cycle duration. This is typically how consumers specify the duration.
  • The time for the animation to go between two arbitrary relative timestamps is the segment duration. This is used in a few places like snapshot testing and the upcoming interactive animations.

See original suggestion in #49 (comment)

@NickEntin
Copy link
Collaborator Author

And @seanho's response to that comment:

This makes sense, total can be ambiguous when animation has multiple phases. end-to-end sounds good but feels a bit clumsy as variable name, what about overall duration?

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation
Projects
None yet
Development

No branches or pull requests

1 participant