miguel-perez/smoothState.js

Callsbacks (or hooks) on the website and github documentation do not correspond with each other

Open

#191 opened on Jul 1, 2015

View on GitHub
 (3 comments) (0 reactions) (0 assignees)CSS (4,433 stars) (515 forks)batch import
gh-pages bughelp wanted

Description

On the website, these callbacks are listed in the documentation:

  • onStart
  • onProgress
  • onEnd

But on the GitHub documentation, these hooks are listed:

  • onBefore
  • onStart
  • onProgress
  • onReady
  • onAfter

I'm going to assume the ones on github are the right ones, but now many people is using onEnd because that's what is in all the online examples, while onEnd is nowhere to be found on the GitHub documentation.

Contributor guide

Tech stack
javascript
Domain
documentation
Issue type
documentation
DifficultyEstimated implementation difficulty for a new contributor, from 1 for very small changes to 5 for expert-level work.
1
Estimated timeA rough time range for an experienced contributor to investigate, implement, test, and prepare a pull request.
under 1 hour
Activity statusHow available the issue appears right now: fresh, active, stale, blocked, or waiting on maintainer input.
stale
ClarityHow clearly the issue explains the expected change, acceptance criteria, and next step.
clear
Prerequisites
None
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
90
Research direction
The issue identifies a mismatch between callback names listed on the official website (http://smoothstate.com/advanced implementation.html) and the GitHub documentation. The author suspects the GitHub documentation is correct. The fix involves updating one of the documentation sources to match the other, after verifying the actual code behavior. This is a straightforward, localized documentation task.