miguel-perez/smoothState.js

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

Open

#191 geöffnet am 1. Juli 2015

Auf GitHub ansehen
 (3 Kommentare) (0 Reaktionen) (0 zugewiesene Personen)CSS (515 Forks)batch import
gh-pages bughelp wanted

Repository-Metriken

Stars
 (4.433 Stars)
PR-Merge-Metriken
 (Keine gemergten PRs in 30 T)

Beschreibung

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

Research-Richtung
Das Problem identifiziert eine Nichtübereinstimmung zwischen den auf der offiziellen Website (http://smoothstate.com/advanced implementation.html) aufgelisteten Callback Namen und der GitHub Dokumentation. Der Autor vermutet, dass die GitHub Dokumentation korrekt ist. Die Lösung besteht darin, eine der Dokumentationsquellen nach Überprüfung des tatsächlichen Code Verhaltens an die andere anzupassen. Dies ist eine einfache, lokalisierte Dokumentationsaufgabe.
Tech Stack
javascript
Domain
documentation
Issue Type
Dokumentation
SchwierigkeitGeschätzte Implementierungsschwierigkeit für neue Contributors, von 1 für sehr kleine Änderungen bis 5 für Expertenarbeit.
1
Geschätzte ZeitEin grober Zeitrahmen, um zu recherchieren, zu implementieren, zu testen und einen Pull Request vorzubereiten.
Unter 1 Stunde
AktivitätsstatusWie verfügbar das Issue gerade wirkt: frisch, aktiv, stale, blockiert oder wartet auf Maintainer-Input.
Veraltet
KlarheitWie klar das Issue die erwartete Änderung, Akzeptanzkriterien und den nächsten Schritt erklärt.
Klar
Voraussetzungen
Keine
EinsteigerfreundlichkeitEin Score von 1 bis 100, der schätzt, wie zugänglich dieses Issue für First-Time Contributors ist.
90