miguel-perez/smoothState.js

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

Open

#191 建立於 2015年7月1日

在 GitHub 查看
 (3 留言) (0 反應) (0 負責人)CSS (4,433 star) (515 fork)batch import
gh-pages bughelp wanted

描述

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.

貢獻者指南

技術棧
javascript
領域
documentation
議題類型
documentation
難度面向新貢獻者的預計實作難度，1 表示很小改動，5 表示專家級工作。
1
預計時間有經驗貢獻者完成調查、實作、測試並準備 pull request 的粗略時間範圍。
under 1 hour
活動狀態議題目前的可參與程度：新鮮、活躍、陳舊、阻塞或等待維護者輸入。
stale
清晰度議題是否清楚說明預期改動、驗收標準和下一步。
clear
前置要求
無
新手友善度1-100 的估計分數，表示該議題對首次貢獻者的友善程度。
90
研究方向
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.